graphql.nut.ts

/*
 * Copyright 2026, Salesforce, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { join } from 'node:path';
import fs from 'node:fs';
import { config, expect } from 'chai';
import { execCmd, TestSession } from '@salesforce/cli-plugins-testkit';

config.truncateThreshold = 0;

describe('api:request:graphql NUT', () => {
  let testSession: TestSession;

  before(async () => {
    testSession = await TestSession.create({
      scratchOrgs: [
        {
          config: 'config/project-scratch-def.json',
          setDefault: true,
        },
      ],
      project: { sourceDir: join('test', 'test-files', 'data-project') },
      devhubAuthStrategy: 'AUTO',
    });
  });

  after(async () => {
    await testSession?.clean();
  });

  describe('std out', () => {
    it('get result in json format', () => {
      const result = execCmd(`api request graphql --body ${join(testSession.project.dir, 'standard.txt')}`).shellOutput
        .stdout;

      // make sure we got a JSON object back
      const parsed = JSON.parse(result) as Record<string, unknown>;
      expect(Object.keys(parsed)).to.have.length;

      // @ts-expect-error graphql response, just access what we need without typing it
      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
      expect(parsed.data!.uiapi.query.Account.edges.length).to.equal(1);
      expect(parsed.errors).to.deep.equal([]);
    });

    it('get result in json format --body', () => {
      const result = execCmd(
        'api request graphql --body "query accounts { uiapi { query { Account { edges { node { Id Name { value } } } } } } }"'
      ).shellOutput.stdout;

      // make sure we got a JSON object back
      const parsed = JSON.parse(result) as Record<string, unknown>;

      expect(Object.keys(parsed)).to.have.length;

      // @ts-expect-error graphql response, just access what we need without typing it
      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
      expect(parsed.data!.uiapi.query.Account.edges.length).to.equal(1);
      expect(parsed.errors).to.deep.equal([]);
    });

    it('no results from --body', () => {
      const result = execCmd(
        'api request graphql  --body "query Address {  uiapi {   query {Address { edges {  node {    Id }  }  }  } }}"'
      ).shellOutput.stdout;

      // make sure we got a JSON object back
      const parsed = JSON.parse(result) as Record<string, unknown>;
      expect(Object.keys(parsed)).to.have.length;

      // @ts-expect-error graphql response, just access what we need without typing it
      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
      expect(parsed.data!.uiapi.query.Address.edges.length).to.equal(0);
      expect(parsed.errors).to.deep.equal([]);
    });

    it('get no results correctly', () => {
      const result = execCmd(`api request graphql --body ${join(testSession.project.dir, 'noResults.txt')}`).shellOutput
        .stdout;
      // make sure we got a JSON object back
      const parsed = JSON.parse(result) as Record<string, unknown>;
      expect(Object.keys(parsed)).to.have.length;
      // @ts-expect-error graphql response, just access what we need without typing it
      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
      expect(parsed.data!.uiapi.query.Address.edges.length).to.equal(0);
      expect(parsed.errors).to.deep.equal([]);
    });
  });

  describe('stream-to-file', () => {
    it('get result in json format', () => {
      execCmd(`api request graphql --body ${join(testSession.project.dir, 'standard.txt')} --stream-to-file out.txt`)
        .shellOutput.stdout;
      // make sure we got a JSON object back
      const parsed = JSON.parse(fs.readFileSync(join(testSession.project.dir, 'out.txt'), 'utf8')) as Record<
        string,
        unknown
      >;
      expect(Object.keys(parsed)).to.have.length;
      // @ts-expect-error graphql response, just access what we need without typing it
      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
      expect(parsed.data!.uiapi.query.Account.edges.length).to.equal(1);
      expect(parsed.errors).to.deep.equal([]);
    });

    it('get no results correctly', () => {
      execCmd(`api request graphql --body ${join(testSession.project.dir, 'noResults.txt')} --stream-to-file empty.txt`)
        .shellOutput.stdout;

      // make sure we got a JSON object back
      const parsed = JSON.parse(fs.readFileSync(join(testSession.project.dir, 'empty.txt'), 'utf8')) as Record<
        string,
        unknown
      >;
      expect(Object.keys(parsed)).to.have.length;
      // @ts-expect-error graphql response, just access what we need without typing it
      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
      expect(parsed.data!.uiapi.query.Address.edges.length).to.equal(0);
      expect(parsed.errors).to.deep.equal([]);
    });
  });
});