fix: [ENG-8644] overriding omit in fetchOneEntry to be empty string

.changeset/slimy-islands-end.md

@@ -0,0 +1,14 @@
+---
+"@builder.io/sdk": patch
+"@builder.io/react": patch
+"@builder.io/sdk-angular": patch
+"@builder.io/sdk-react-nextjs": patch
+"@builder.io/sdk-qwik": patch
+"@builder.io/sdk-react": patch
+"@builder.io/sdk-react-native": patch
+"@builder.io/sdk-solid": patch
+"@builder.io/sdk-svelte": patch
+"@builder.io/sdk-vue": patch
+---
+
+Fix: correctly set default value for `omit` field as `meta.componentsUsed` in Content API calls and preserve empty string

packages/core/src/builder.class.ts

@@ -2503,7 +2503,7 @@ export class Builder {
 
     const queryParams: ParamsMap = {
       // TODO: way to force a request to be in a separate queue. or just lower queue limit to be 1 by default
-      omit: queue[0].omit || 'meta.componentsUsed',
+      omit: queue[0].omit ?? 'meta.componentsUsed',
       apiKey: this.apiKey,
       ...queue[0].options,
       ...this.queryOptions,

packages/sdks-tests/src/e2e-tests/hit-content-api.spec.ts

@@ -41,8 +41,9 @@ test.describe('Get Content', () => {
     expect(await req!.postDataJSON()).toEqual({ test: 'test' });
     expect(req!.method()).toBe('POST');
   });
-  test('fetch symbol with query.id', async ({ page, sdk }) => {
+  test('fetch symbol with query.id', async ({ page, sdk, packageName }) => {
     test.skip(!excludeGen1(sdk));
+    test.skip(packageName !== 'gen1-next14-pages');
 
     let x = 0;
     let headers;
@@ -78,4 +79,94 @@ test.describe('Get Content', () => {
     expect(headers?.['x-builder-sdk-gen']).toBe(getSdkGeneration(sdk));
     expect(headers?.['x-builder-sdk-version']).toMatch(/\d+\.\d+\.\d+/); // Check for semver format
   });
+
+  test('should NOT omit componentsUsed when omit parameter is explicitly set to empty string', async ({
+    page,
+    sdk,
+  }) => {
+    test.skip(!excludeGen1(sdk));
+
+    let builderRequestPromise: Promise<string> | undefined = undefined;
+    let requestUrl: string | undefined;
+
+    const builderApiRegex = /https:\/\/cdn\.builder\.io\/api\/v3\//;
+
+    await page.goto('/get-content-with-omit');
+
+    builderRequestPromise = new Promise<string>(resolve => {
+      page.on('request', request => {
+        const url = request.url();
+        if (builderApiRegex.test(url)) {
+          requestUrl = url;
+          resolve(url);
+        }
+      });
+    });
+
+    await page.reload({ waitUntil: 'networkidle' });
+    await builderRequestPromise;
+
+    expect(requestUrl).toBeDefined();
+    expect(requestUrl!).not.toContain('omit=meta.componentsUsed');
+    expect(requestUrl!.includes('omit=')).toBeTruthy();
+    expect(new URL(requestUrl!).searchParams.get('omit')).toBe('');
+  });
+
+  test('should omit the specified field when omit parameter has a defined value for gen1', async ({
+    page,
+    sdk,
+  }) => {
+    test.skip(!excludeGen1(sdk));
+
+    let builderRequestPromise: Promise<string> | undefined = undefined;
+    let requestUrl: string | undefined;
+
+    const builderApiRegex = /https:\/\/cdn\.builder\.io\/api\/v3\//;
+
+    await page.goto('/get-content-with-omit-name');
+
+    builderRequestPromise = new Promise<string>(resolve => {
+      page.on('request', request => {
+        const url = request.url();
+        if (builderApiRegex.test(url)) {
+          requestUrl = url;
+          resolve(url);
+        }
+      });
+    });
+
+    await page.reload({ waitUntil: 'networkidle' });
+    await builderRequestPromise;
+
+    expect(requestUrl).toBeDefined();
+    expect(requestUrl!).toContain('omit=name');
+    expect(new URL(requestUrl!).searchParams.get('omit')).toBe('name');
+  });
+
+  test('should use default omit value when omit parameter is undefined', async ({ page, sdk }) => {
+    test.skip(!excludeGen1(sdk));
+
+    let builderRequestPromise: Promise<string> | undefined = undefined;
+    let requestUrl: string | undefined;
+
+    const builderApiRegex = /https:\/\/cdn\.builder\.io\/api\/v3\//;
+
+    await page.goto('/get-content-default');
+
+    builderRequestPromise = new Promise<string>(resolve => {
+      page.on('request', request => {
+        const url = request.url();
+        if (builderApiRegex.test(url)) {
+          requestUrl = url;
+          resolve(url);
+        }
+      });
+    });
+
+    await page.reload({ waitUntil: 'networkidle' });
+    await builderRequestPromise;
+
+    const omitValue = new URL(requestUrl!).searchParams.get('omit');
+    expect(omitValue).toBe('meta.componentsUsed');
+  });
 });

packages/sdks-tests/src/specs/index.ts

@@ -401,6 +401,23 @@ export const getProps = async (args: {
         apiEndpoint: 'content',
       };
       break;
+    case '/get-content-with-omit':
+      extraProps = {
+        apiEndpoint: 'content',
+        omit: '',
+      };
+      break;
+    case '/get-content-with-omit-name':
+        extraProps = {
+          apiEndpoint: 'content',
+          omit: 'name',
+        };
+      break;
+    case '/get-content-default':
+        extraProps = {
+          apiEndpoint: 'content',
+        };
+      break;
     case '/get-query':
       extraProps = {
         options: { apiEndpoint: 'query', format: 'html', model: 'abcd', key: 'abcd' },

packages/sdks/src/functions/__snapshots__/register-component.test.ts.snap

@@ -28,21 +28,6 @@ exports[`Component Registration and Serialization > serializeComponentInfo handl
 }
 `;
 
-exports[`Component Registration and Serialization > serializeComponentInfo handles async arrow functions correctly 1`] = `
-{
-  "inputs": [
-    {
-      "name": "testInput",
-      "onChange": "return (async (value) => {
-            return value.toUpperCase();
-          }).apply(this, arguments)",
-      "type": "string",
-    },
-  ],
-  "name": "TestComponent",
-}
-`;
-
 exports[`Component Registration and Serialization > serializeComponentInfo handles async arrow functions without parenthesis correctly 1`] = `
 {
   "inputs": [

packages/sdks/src/functions/get-content/__snapshots__/generate-content-url.test.ts.snap

@@ -30,4 +30,10 @@ exports[`Generate Content URL > generate content url with omit, fields, offset,
 
 exports[`Generate Content URL > generates the proper value for a simple query 1`] = `"https://cdn.builder.io/api/v3/content/page?apiKey=YJIGb4i01jvw0SRdL5Bt&limit=30&noTraverse=true&includeRefs=true&omit=meta.componentsUsed&query.id=%22c1b81bab59704599b997574eb0736def%22"`;
 
+exports[`Generate Content URL > handles defined as omit parameter values 1`] = `"https://cdn.builder.io/api/v3/content/page?apiKey=YJIGb4i01jvw0SRdL5Bt&limit=30&noTraverse=true&includeRefs=true&omit=name"`;
+
+exports[`Generate Content URL > handles empty string as omit parameter values 1`] = `"https://cdn.builder.io/api/v3/content/page?apiKey=YJIGb4i01jvw0SRdL5Bt&limit=30&noTraverse=true&includeRefs=true&omit="`;
+
+exports[`Generate Content URL > handles undefined as omit parameter values 1`] = `"https://cdn.builder.io/api/v3/content/page?apiKey=YJIGb4i01jvw0SRdL5Bt&limit=30&noTraverse=true&includeRefs=true&omit=meta.componentsUsed"`;
+
 exports[`Generate Content URL > preserves both userAttributes.locale and top-level locale when both provided 1`] = `"https://cdn.builder.io/api/v3/content/page?apiKey=YJIGb4i01jvw0SRdL5Bt&limit=30&noTraverse=true&includeRefs=true&locale=en-US&omit=meta.componentsUsed&userAttributes=%7B%22locale%22%3A%22es-ES%22%2C%22foo%22%3A%22bar%22%7D"`;

packages/sdks/src/functions/get-content/generate-content-url.test.ts

@@ -35,6 +35,33 @@ describe('Generate Content URL', () => {
     expect(output).toMatchSnapshot();
   });
 
+  test('handles empty string as omit parameter values', () => {
+    const outputEmptyString = generateContentUrl({
+      apiKey: testKey,
+      model: testModel,
+      omit: '',
+    });
+    expect(outputEmptyString).toMatchSnapshot();
+  });
+
+  test('handles undefined as omit parameter values', () => {
+    const outputUndefined = generateContentUrl({
+      apiKey: testKey,
+      model: testModel,
+      omit: undefined,
+    });
+    expect(outputUndefined).toMatchSnapshot();
+  });
+
+  test('handles defined as omit parameter values', () => {
+    const outputDefined = generateContentUrl({
+      apiKey: testKey,
+      model: testModel,
+      omit: 'name',
+    });
+    expect(outputDefined).toMatchSnapshot();
+  });
+
   test('generate content url with apiVersion as default', () => {
     const output = generateContentUrl({
       apiKey: testKey,

packages/sdks/src/functions/get-content/generate-content-url.ts

@@ -65,7 +65,7 @@ export const generateContentUrl = (options: GetContentOptions): URL => {
   }
   if (enrich) url.searchParams.set('enrich', String(enrich));
 
-  url.searchParams.set('omit', omit || 'meta.componentsUsed');
+  url.searchParams.set('omit', omit ?? 'meta.componentsUsed');
 
   if (fields) {
     url.searchParams.set('fields', fields);