fix[gen1][core] ENG-7841 change to queryParams

[clyde-builderio]

Description

Gen1 SDK: use same Content API defaults as Gen2 SDK

[changeset-bot]

🦋 Changeset detected

Latest commit: c11643b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@builder.io/sdk	Patch
@builder.io/react	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[nx-cloud]

View your CI Pipeline Execution ↗ for commit c11643b.

Command	Status	Duration	Result
nx test @e2e/angular	❌ Failed	5m 34s	View ↗
nx test @snippet/react-sdk-next-pages	❌ Failed	2m 27s	View ↗
nx test @e2e/react-sdk-next-pages	❌ Failed	2m 2s	View ↗
nx test @e2e/nextjs-sdk-next-app	✅ Succeeded	8m 17s	View ↗
nx test @e2e/nuxt	✅ Succeeded	7m 46s	View ↗
nx test @e2e/qwik-city	✅ Succeeded	7m 56s	View ↗
nx test @e2e/react-native	✅ Succeeded	6m 2s	View ↗
nx test @e2e/sveltekit	✅ Succeeded	5m 46s	View ↗
Additional runs (33)	✅ Succeeded	...	View ↗

---

☁️ Nx Cloud last updated this comment at 2024-12-20 13:39:33 UTC

[samijaber]

We should move this logic before the following code blocks:

• builder/packages/core/src/builder.class.ts

  Lines 2604 to 2616 in 1908d27

  	for (const key of properties) {
  	const value = options[key];
  	if (value !== undefined) {
  	if (this.apiEndpoint === 'query') {
  	queryParams.options = queryParams.options || {};
  	queryParams.options[options.key!] = queryParams.options[options.key!] || {};
  	queryParams.options[options.key!][key] = JSON.stringify(value);
  	} else {
  	queryParams[key] = JSON.stringify(value);
  	}
  	}
  	}
  	}

• builder/packages/core/src/builder.class.ts

  Lines 2627 to 2630 in 1908d27

  	if (this.overrideParams) {
  	const params = omit(QueryString.parse(this.overrideParams), 'apiKey');
  	assign(queryParams, params);
  	}

These are two ways customers can override properties, so they need to exist after you set the noTraverse and includeRefs defaults.

I also just noticed these two noTraverse settings:

builder/packages/core/src/builder.class.ts

Lines 2495 to 2497 in 1908d27

	if ('noTraverse' in queue[0]) {
	queryParams.noTraverse = queue[0].noTraverse;
	}

builder/packages/core/src/builder.class.ts

Lines 2863 to 2867 in 1908d27

	// Set noTraverse=true if NOT already passed by user, for query performance
	if (!('noTraverse' in options)) {
	options.noTraverse = true;
	}

This means that noTraverse is already handled (set to true in getAll() which has limit > 1. So you don't need to set noTraverse, you only need to add the includeRefs = true.

TLDR:

• remove noTraverse default
• move the includeRefs default higher up so it can still be overridden by customer
• add some tests that show:
  • default value of includeRefs is true
  • if customer provides includeRefs: false to builder.get() or builder.getAll(), then they are able to update the URL

[gitguardian]

⚠️ GitGuardian has uncovered 2 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

Since your pull request originates from a forked repository, GitGuardian is not able to associate the secrets uncovered with secret incidents on your GitGuardian dashboard.
Skipping this check run and merging your pull request will create secret incidents on your GitGuardian dashboard.

🔎 Detected hardcoded secrets in your pull request

GitGuardian id	GitGuardian status	Secret	Commit	Filename
14200383	Triggered	Generic High Entropy Secret	42a258b	packages/core/src/builder.class.test.ts	View secret
14200385	Triggered	Generic High Entropy Secret	42a258b	packages/core/src/builder.class.test.ts	View secret

🛠 Guidelines to remediate hardcoded secrets

1. Understand the implications of revoking this secret by investigating where it is used in your code.
2. Replace and store your secrets safely. Learn here the best practices.
3. Revoke and rotate these secrets.
4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

• following these best practices for managing and storing secrets including API keys and other credentials
• install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

---

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.}

[sidmohanty11]

should it be?

Suggested change

	if (!('noTraverse' in options)) {
	if (!('noTraverse' in options) && this.apiEndpoint === 'content') {

[samijaber]

Actually, @sanyamkamat correct me if i'm wrong but I think we want the noTraverse default for Query and Content.

[sanyamkamat]

When will there be any apiEndpoint which will not be content?

[sanyamkamat]

@samijaber Replied to your question in slack thread.