feat(api): add query parser #7267

djabarovgeorge · 2024-12-10T19:00:05Z

What changed? Why was the change needed?

Screenshots

Expand for optional sections

Related enterprise PR

Special notes for your reviewer

…luate-skip-conditions-in-shared-bridge-endpoint # Conflicts: # pnpm-lock.yaml

…luate-skip-conditions-in-shared-bridge-endpoint

linear · 2024-12-10T19:00:09Z

NV-4898 Store & evaluate skip conditions in shared BridgeEndpoint

netlify · 2024-12-10T19:00:21Z

✅ Deploy Preview for dashboard-v2-novu-staging ready!

Name	Link
🔨 Latest commit	`9f9534c`
🔍 Latest deploy log	https://app.netlify.com/sites/dashboard-v2-novu-staging/deploys/67596ce96771b300089bde8d
😎 Deploy Preview	https://deploy-preview-7267.dashboard-v2.novu-staging.co
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify · 2024-12-10T19:00:24Z

✅ Deploy Preview for dev-web-novu ready!

Name	Link
🔨 Latest commit	`9f9534c`
🔍 Latest deploy log	https://app.netlify.com/sites/dev-web-novu/deploys/67596ce950a1cd0008a999c1
😎 Deploy Preview	https://deploy-preview-7267.dashboard.novu-staging.co
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

djabarovgeorge · 2024-12-10T19:01:16Z

packages/shared/src/dto/workflows/step.dto.ts

@@ -84,6 +85,7 @@ export enum UiComponentEnum {
  CHAT_BODY = 'CHAT_BODY',
  PUSH_BODY = 'PUSH_BODY',
  PUSH_SUBJECT = 'PUSH_SUBJECT',
+  SKIP_RULES = 'SKIP_RULES',


was not sure how to call. should we switch to SKIP?

Suggested change

SKIP_RULES = 'SKIP_RULES',

SKIP = 'SKIP',

Suggested change

SKIP_RULES = 'SKIP_RULES',

SKIP_RULES = 'QUERY_EDITOR',

djabarovgeorge · 2024-12-10T19:02:10Z

apps/api/src/app/shared/services/query-parser/query-parser.service.ts

@@ -0,0 +1,47 @@
+import jsonLogic, { AdditionalOperation, RulesLogic } from 'json-logic-js';
+
+const initializeCustomOperators = (): void => {


self note:
validate that we cover all the react-querybuilder operators.

Nice! @djabarovgeorge Isn't there an npm package that does this already so that it saves us from adding custom operators?

Do they maybe have it for another JSON representation of conditionals that is more complete out of the box?

What about this?

If not, it's a great opportunity to make an OS contribution to react-querybuilder.

djabarovgeorge · 2024-12-10T19:05:02Z

...nvironments-v1/usecases/construct-framework-workflow/construct-framework-workflow.usecase.ts

@@ -199,7 +209,25 @@ export class ConstructFrameworkWorkflow {

    return foundWorkflow;
  }
+
+  private processSkipOption(controlValues: { [x: string]: unknown }, variables: FullPayloadForRender) {


we can convert this to renderer.

as a side note, at the moment i am not sure we need to have Injectable use-cases for the renderer feels like overkill.

djabarovgeorge · 2024-12-11T10:01:49Z

...nvironments-v1/usecases/construct-framework-workflow/construct-framework-workflow.usecase.ts

+  private constructCommonStepOptions(
+    staticStep: NotificationStepEntity,
+    fullPayloadForRender: FullPayloadForRender


we need FullPayloadForRender variables(===frameweork.payload) data in the skip method to execute the skip function.

djabarovgeorge · 2024-12-11T10:02:42Z

apps/api/src/app/events/e2e/trigger-event.e2e.ts


    return (await novuClient.trigger(request)).result;
  }
+
+  describe('Trigger Event New Dashboard - /v1/events/trigger (POST)', function () {


should we rename it to v2 workflow?

Suggested change

describe('Trigger Event New Dashboard - /v1/events/trigger (POST)', function () {

describe('Trigger Event v2 workflow - /v1/events/trigger (POST)', function () {

pkg-pr-new · 2024-12-11T10:04:38Z

Open in Stackblitz

@novu/client

npm i https://pkg.pr.new/novuhq/novu/@novu/client@7267

@novu/framework

npm i https://pkg.pr.new/novuhq/novu/@novu/framework@7267

@novu/headless

npm i https://pkg.pr.new/novuhq/novu/@novu/headless@7267

@novu/js

npm i https://pkg.pr.new/novuhq/novu/@novu/js@7267

@novu/nest

npm i https://pkg.pr.new/novuhq/novu/@novu/nest@7267

@novu/nextjs

npm i https://pkg.pr.new/novuhq/novu/@novu/nextjs@7267

@novu/node

npm i https://pkg.pr.new/novuhq/novu/@novu/node@7267

@novu/notification-center

npm i https://pkg.pr.new/novuhq/novu/@novu/notification-center@7267

novu

npm i https://pkg.pr.new/novuhq/novu@7267

@novu/providers

npm i https://pkg.pr.new/novuhq/novu/@novu/providers@7267

@novu/react

npm i https://pkg.pr.new/novuhq/novu/@novu/react@7267

@novu/react-native

npm i https://pkg.pr.new/novuhq/novu/@novu/react-native@7267

@novu/shared

npm i https://pkg.pr.new/novuhq/novu/@novu/shared@7267

@novu/stateless

npm i https://pkg.pr.new/novuhq/novu/@novu/stateless@7267

commit: 9f9534c

djabarovgeorge · 2024-12-11T10:05:10Z

apps/api/src/app/shared/services/query-parser/query-parser.service.spec.ts

the main reason for this spec is that we are adding new operators to the json logic js, which are not tests in json logic js. Therefore, we need to make sure we are testing it here.

SokratisVidros

👏 👏 👏

SokratisVidros · 2024-12-12T05:15:12Z

...nvironments-v1/usecases/construct-framework-workflow/construct-framework-workflow.usecase.ts

        );
      case StepTypeEnum.DELAY:
        return step.delay(
          stepId,
          async (controlValues) => {
            return this.delayOutputRendererUseCase.execute({ controlValues, fullPayloadForRender });
          },
-          this.constructActionStepOptions(staticStep)
+          this.constructActionStepOptions(staticStep, fullPayloadForRender)


Nit-picky: This function is the same across all steps, we can remove it out side the switch.

SokratisVidros · 2024-12-12T05:16:03Z

...nvironments-v1/usecases/construct-framework-workflow/construct-framework-workflow.usecase.ts

-       * Used to construct conditions defined with https://react-querybuilder.js.org/ or similar
-       */
-      skip: (controlValues) => false,
+      skip: (controlValues: { [x: string]: unknown }) => this.processSkipOption(controlValues, fullPayloadForRender),


Suggested change

skip: (controlValues: { [x: string]: unknown }) => this.processSkipOption(controlValues, fullPayloadForRender),

skip: (controlValues: Record<string, unknown>) => this.processSkipOption(controlValues, fullPayloadForRender),

SokratisVidros · 2024-12-12T05:17:06Z

...nvironments-v1/usecases/construct-framework-workflow/construct-framework-workflow.usecase.ts

+    const skipRules = controlValues.skip as RulesLogic<AdditionalOperation>;
+
+    // TODO: check if we need to add more validation here (is empty object, etc.)
+    if (!skipRules) {


We can use lodash/isEmpty and cover all of the empty cases of an object ;)

Suggested change

if (!skipRules) {

if (isEmpty(skipRules)) {

SokratisVidros · 2024-12-12T05:17:48Z

...nvironments-v1/usecases/construct-framework-workflow/construct-framework-workflow.usecase.ts

+    const { result, error } = evaluateRules(skipRules, variables);
+
+    if (error) {
+      this.logger.error({ err: error }, 'Failed to evaluate skip rule', LOG_CONTEXT);


Shall we pause workflow execution when there is a skip condition error? I think we should and we need to show it in activity feed.

SokratisVidros · 2024-12-12T05:18:04Z

apps/api/src/app/events/e2e/trigger-event.e2e.ts


    return (await novuClient.trigger(request)).result;
  }
+
+  describe('Trigger Event New Dashboard - /v1/events/trigger (POST)', function () {


SokratisVidros · 2024-12-12T05:22:14Z

apps/api/src/app/shared/services/query-parser/query-parser.service.ts

@@ -0,0 +1,47 @@
+import jsonLogic, { AdditionalOperation, RulesLogic } from 'json-logic-js';
+
+const initializeCustomOperators = (): void => {


Nice! @djabarovgeorge Isn't there an npm package that does this already so that it saves us from adding custom operators?

Do they maybe have it for another JSON representation of conditionals that is more complete out of the box?

What about this?

If not, it's a great opportunity to make an OS contribution to react-querybuilder.

SokratisVidros · 2024-12-12T05:23:18Z

packages/shared/src/dto/workflows/step.dto.ts

@@ -84,6 +85,7 @@ export enum UiComponentEnum {
  CHAT_BODY = 'CHAT_BODY',
  PUSH_BODY = 'PUSH_BODY',
  PUSH_SUBJECT = 'PUSH_SUBJECT',
+  SKIP_RULES = 'SKIP_RULES',


Suggested change

SKIP_RULES = 'SKIP_RULES',

SKIP_RULES = 'QUERY_EDITOR',

djabarovgeorge added 10 commits December 10, 2024 13:47

feat(api): add query parser

2500ec7

feat(api): add skip processing

2c03c7f

feat(api): wip e2e

976a569

feat(api): wip e2e

7c441c6

Merge remote-tracking branch 'origin/next' into nv-4898-store-and-eva…

0a1ad17

…luate-skip-conditions-in-shared-bridge-endpoint # Conflicts: # pnpm-lock.yaml

feat(api): first e2e

5a866bf

feat(api): second e2e

a50500c

Merge remote-tracking branch 'origin/next' into nv-4898-store-and-eva…

026e9f3

…luate-skip-conditions-in-shared-bridge-endpoint

feat(api): align ui and control skip schema

69ec3a9

feat(api): create tests for query parser

2f3c4ad

djabarovgeorge temporarily deployed to Linting December 10, 2024 19:00 — with GitHub Actions Inactive

djabarovgeorge marked this pull request as draft December 10, 2024 19:00

github-actions bot added @novu/api @novu/shared labels Dec 10, 2024

feat(api): align operators with react query builder

9096245

djabarovgeorge temporarily deployed to Linting December 11, 2024 09:59 — with GitHub Actions Inactive

djabarovgeorge commented Dec 11, 2024

View reviewed changes

djabarovgeorge marked this pull request as ready for review December 11, 2024 09:59

djabarovgeorge commented Dec 11, 2024

View reviewed changes

feat(api): refactor operators

9f9534c

SokratisVidros approved these changes Dec 12, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(api): add query parser #7267

feat(api): add query parser #7267

djabarovgeorge commented Dec 10, 2024

linear bot commented Dec 10, 2024

netlify bot commented Dec 10, 2024 •

edited

Loading

netlify bot commented Dec 10, 2024 •

edited

Loading

djabarovgeorge Dec 10, 2024

SokratisVidros Dec 12, 2024

djabarovgeorge Dec 10, 2024

djabarovgeorge Dec 11, 2024

SokratisVidros Dec 12, 2024 •

edited

Loading

djabarovgeorge Dec 10, 2024

djabarovgeorge Dec 11, 2024

djabarovgeorge Dec 11, 2024

SokratisVidros Dec 12, 2024

pkg-pr-new bot commented Dec 11, 2024 •

edited

Loading

djabarovgeorge Dec 11, 2024

SokratisVidros left a comment

SokratisVidros Dec 12, 2024

SokratisVidros Dec 12, 2024

SokratisVidros Dec 12, 2024

SokratisVidros Dec 12, 2024 •

edited

Loading

SokratisVidros Dec 12, 2024

SokratisVidros Dec 12, 2024 •

edited

Loading

SokratisVidros Dec 12, 2024

		@@ -0,0 +1,47 @@
		import jsonLogic, { AdditionalOperation, RulesLogic } from 'json-logic-js';

		const initializeCustomOperators = (): void => {

	describe('Trigger Event New Dashboard - /v1/events/trigger (POST)', function () {
	describe('Trigger Event v2 workflow - /v1/events/trigger (POST)', function () {

	skip: (controlValues: { [x: string]: unknown }) => this.processSkipOption(controlValues, fullPayloadForRender),
	skip: (controlValues: Record<string, unknown>) => this.processSkipOption(controlValues, fullPayloadForRender),

feat(api): add query parser #7267

Are you sure you want to change the base?

feat(api): add query parser #7267

Conversation

djabarovgeorge commented Dec 10, 2024

What changed? Why was the change needed?

Screenshots

Related enterprise PR

Special notes for your reviewer

linear bot commented Dec 10, 2024

netlify bot commented Dec 10, 2024 • edited Loading

✅ Deploy Preview for dashboard-v2-novu-staging ready!

netlify bot commented Dec 10, 2024 • edited Loading

✅ Deploy Preview for dev-web-novu ready!

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

SokratisVidros Dec 12, 2024 • edited Loading

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

pkg-pr-new bot commented Dec 11, 2024 • edited Loading

Choose a reason for hiding this comment

SokratisVidros left a 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

SokratisVidros Dec 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SokratisVidros Dec 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

netlify bot commented Dec 10, 2024 •

edited

Loading

netlify bot commented Dec 10, 2024 •

edited

Loading

SokratisVidros Dec 12, 2024 •

edited

Loading

pkg-pr-new bot commented Dec 11, 2024 •

edited

Loading

SokratisVidros Dec 12, 2024 •

edited

Loading

SokratisVidros Dec 12, 2024 •

edited

Loading