fix: ensure undefined parameters not added to URL

[luqven]

This PR ensures that undefined parameters are not added to the
params object generated by _buildParams. This way, undefined params do
not then end up in the generated URL.

[commit-lint]

Tests

• ensure undefined parameters not present in URL (85d054c)

Bug Fixes

• ensure undefined parameters not added to url (f7fc708)

Contributors

luqven

Commit-Lint commands

You can trigger Commit-Lint actions by commenting on this PR:

• @Commit-Lint merge patch will merge dependabot PR on "patch" versions (X.X.Y - Y change)
• @Commit-Lint merge minor will merge dependabot PR on "minor" versions (X.Y.Y - Y change)
• @Commit-Lint merge major will merge dependabot PR on "major" versions (Y.Y.Y - Y change)
• @Commit-Lint merge disable will desactivate merge dependabot PR
• @Commit-Lint review will approve dependabot PR
• @Commit-Lint stop review will stop approve dependabot PR

[sherwinski]

For my context, would you mind explaining what the motivation for this PR is? In isolation, it seems fine but I'm hesitant to add guardrails for scenarios that don't sound likely to happen?

That is, unless this is proactively guarding against something that we know is happening, such as in a consuming library.

[frederickfogerty]

@sherwinski there was a bug occurring in Gatsby that was caused by this. Basically, we had some code like this:

const imgixParams = {
  ...args.imgixParams,
  ar: (width != null && height != null) ? `${width/height}:1` : undefined
};

const src = client.buildURL(path, imgixParams); // => contains ar=undefined

You can see ar=undefined showing up in the URLs from a user's bug report here: imgix/gatsby#122

I think this is pretty common not only to have undefined values be set by our libraries, but also being passed down from SDK consumers. Thus I would say this has a high impact.

It's a pretty common pattern that if an object value is undefined or null it should be treated as if it is not set. To workaround this we would have to manually prune all null and undefined from the imgixParams object before passing it to js-core in all of our libraries.

[frederickfogerty]

✅

[sherwinski]

@frederickfogerty I guessed as much, but figured I ask anyways 😁