Codestin Search App

anasshakil · 2023-02-21T14:29:37Z

Description

This allows to rename fields using rename context item.

Example

app.post(
  "/user",
  // Promise
  body("search").rename(async (value) => {
    // do some asynchronous task
    if (value.includes("@")) {
      return "email";
    } else if (value.includes("#")) {
      return "tag";
    }
    return null;
  }),
  // Basic
  check("search")
    .rename((value) => {
      if (value.includes("+")) {
        return "phone";
      }
      return undefined;
    })
    .withMessage("An error occurred"),
  // wildcard field with short-circuiting `string`
  body("user.*.addresses.home").rename("accounts.*.users.*.addresses.billing.street"),
  (req, res) => {
    // Handle the request
    const data = matchedData(req);
    res.json(data);
  }
);

Request Body

{
    "search": "[email protected]",
    "user": [
        {
            "addresses": {
                "home":  "billing address street"
            }
        }
    ]
}

Output

{
  "email": "[email protected]",
   "accounts": [
        {
            "users": [
                {
                    "addresses": {
                        "billing": {
                            "street": "billing address street"
                        }
                    }
                }
            ]
        }
    ]
}

closes #785

To-do list

Wildcard support
I have added tests for what I changed.

This pull request is ready to merge.

coveralls · 2023-02-22T12:45:13Z

Coverage: 99.263% (-0.7%) from 100.0% when pulling 5d4dafc on anasshakil:master into eba0cfe on express-validator:master.

gustavohenke · 2023-02-22T12:49:18Z

src/context-items/custom-validation.ts

+      if (typeof actualResult === 'string') {
+        context.renameFieldInstance(actualResult, meta);


May I ask why you thought of making use of the custom validators?

Changing the meaning of the return of a custom validator will be quite disruptive for everybody, and is certainly a breaking change.

Perhaps a new function in the chain would be a better idea?

We ran into a problem where we needed to rename the search field on the bases of the input. I thought of the custom validator as a solution because it solves both of the requirements. To avoid the breaking change, we can accept the return type of an object containing a field, for example { express_rename: 'foo' }.

gustavohenke · 2023-02-22T12:52:36Z

src/context.ts

+    if (this.fields.length !== 1) {
+      throw new Error('Attempt to rename multiple fields.');
+    }
+    if (/\.|\*/g.test(originalPath)) {
+      throw new Error('Attempt to rename a wildcard field');
+    }


Nice thinking here. I suppose that the callback should be able to handle the name to give to a field though -- as it has access to the full original path.

I had some success on renaming wildcard paths but need to do more work for wildcard support

- Wildcard support - Test cases added for wildcard and non-wildcard field rename

gustavohenke

General question: should the old property be removed when renaming the item?

renameFieldInstance will work for setting the new property with the same value as the old field instance, but it won't touch the old one.

express-validator/src/chain/context-runner-impl.ts

Lines 50 to 54 in eba0cfe

    
           // Avoids e.g. undefined values being set on the request if it didn't have the key initially. 
        
           const reqValue = path !== '' ? _.get(req[location], path) : req[location]; 
        
           if (!options.dryRun && reqValue !== instance.value) { 
        
             path !== '' ? _.set(req[location], path, newValue) : _.set(req, location, newValue); 
        
           }

gustavohenke · 2023-03-04T01:24:22Z

src/chain/validators.ts

+   * @param evaluator the custom evaluator based on the `CustomValidator`
+   * @returns the current validation chain
+   */
+  rename(evaluator: CustomValidator): Return;


Nice, this is better!
A few comments here though:

This shouldn't stay in the Validators interface. ContextHandler sounds more like it.

Let's add a type specific for the rename callback, so that CustomValidator can evolve independently from the rename functionality.

WDYT of accepting a string value too, which works as a shortcut? For example, rename('banana') automatically renames that field to banana.

gustavohenke · 2023-03-04T01:25:07Z

src/context-items/rename-field.ts

+import { ContextItem } from './context-item';
+
+export class RenameFieldContextItem implements ContextItem {
+  message: any;


When you move rename out of Validators, I think that this won't be necessary anymore

gustavohenke · 2023-03-04T01:25:17Z

src/context-items/rename-field.ts

+export class RenameFieldContextItem implements ContextItem {
+  message: any;
+
+  constructor(private readonly evaluator: CustomValidator, private readonly negated: boolean) {}


Ditto for negated

- Shifted rename functionality to context handler

Rename field using custom validator

61e2012

anasshakil closed this Feb 21, 2023

fixes

c2a7195

anasshakil reopened this Feb 21, 2023

gustavohenke requested changes Feb 22, 2023

View reviewed changes

- Rename functionality separated from CustomValidation

5d4dafc

- Wildcard support - Test cases added for wildcard and non-wildcard field rename

anasshakil requested a review from gustavohenke February 27, 2023 12:05

anasshakil changed the title ~~Rename field using custom validator~~ Rename field with wildcard support Feb 27, 2023

gustavohenke requested changes Mar 4, 2023

View reviewed changes

- Added short-circuiting for string. E.g rename("email")

8cda05b

- Shifted rename functionality to context handler

anasshakil requested a review from gustavohenke March 9, 2023 11:25

gustavohenke force-pushed the master branch 2 times, most recently from 3177f64 to 6e160b1 Compare April 7, 2023 12:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Rename field with wildcard support#1215

Rename field with wildcard support#1215
anasshakil wants to merge 4 commits intoexpress-validator:masterfrom
anasshakil:master

anasshakil commented Feb 21, 2023 •

edited

Loading

Uh oh!

coveralls commented Feb 22, 2023 •

edited

Loading

Uh oh!

gustavohenke Feb 22, 2023

Uh oh!

anasshakil Feb 22, 2023 •

edited

Loading

Uh oh!

gustavohenke Feb 22, 2023

Uh oh!

anasshakil Feb 22, 2023

Uh oh!

gustavohenke left a comment

Uh oh!

gustavohenke Mar 4, 2023

Uh oh!

gustavohenke Mar 4, 2023

Uh oh!

gustavohenke Mar 4, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		if (typeof actualResult === 'string') {
		context.renameFieldInstance(actualResult, meta);

	// Avoids e.g. undefined values being set on the request if it didn't have the key initially.
	const reqValue = path !== '' ? _.get(req[location], path) : req[location];
	if (!options.dryRun && reqValue !== instance.value) {
	path !== '' ? _.set(req[location], path, newValue) : _.set(req, location, newValue);
	}

Uh oh!

Conversation

anasshakil commented Feb 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

To-do list

Uh oh!

coveralls commented Feb 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gustavohenke Feb 22, 2023

Choose a reason for hiding this comment

Uh oh!

anasshakil Feb 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gustavohenke Feb 22, 2023

Choose a reason for hiding this comment

Uh oh!

anasshakil Feb 22, 2023

Choose a reason for hiding this comment

Uh oh!

gustavohenke left a comment

Choose a reason for hiding this comment

Uh oh!

gustavohenke Mar 4, 2023

Choose a reason for hiding this comment

Uh oh!

gustavohenke Mar 4, 2023

Choose a reason for hiding this comment

Uh oh!

gustavohenke Mar 4, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

anasshakil commented Feb 21, 2023 •

edited

Loading

coveralls commented Feb 22, 2023 •

edited

Loading

anasshakil Feb 22, 2023 •

edited

Loading