superset-frontend/src/SqlLab/utils/emptyQueryResults.test.ts

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 type { QueryResponse } from '@superset-ui/core';
import {
  emptyQueryResults,
  clearQueryEditors,
} from 'src/SqlLab/utils/reduxStateToLocalStorageHelper';
import {
  KB_STORAGE,
  BYTES_PER_CHAR,
  LOCALSTORAGE_MAX_QUERY_AGE_MS,
  LOCALSTORAGE_MAX_QUERY_RESULTS_KB,
} from 'src/SqlLab/constants';
import { queries, defaultQueryEditor } from '../fixtures';

// eslint-disable-next-line no-restricted-globals -- TODO: Migrate from describe blocks
describe('reduxStateToLocalStorageHelper', () => {
  const queriesObj: Record<string, any> = {};
  beforeEach(() => {
    queries.forEach(q => {
      queriesObj[q.id] = q;
    });
  });

  test('should empty query.results if query.startDttm is > LOCALSTORAGE_MAX_QUERY_AGE_MS', () => {
    // make sure sample data contains old query
    const oldQuery = queries[0];
    const { id, startDttm } = oldQuery;
    expect(Date.now() - startDttm).toBeGreaterThan(
      LOCALSTORAGE_MAX_QUERY_AGE_MS,
    );
    expect(Object.keys(oldQuery.results || {})).toContain('data');

    const emptiedQuery = emptyQueryResults(queriesObj);
    expect(emptiedQuery[id].startDttm).toBe(startDttm);
    expect(emptiedQuery[id].results).toEqual({});
  });

  test('should empty query.results if query,.results size is greater than LOCALSTORAGE_MAX_QUERY_RESULTS_KB', () => {
    const reasonableSizeQuery = {
      ...queries[0],
      startDttm: Date.now(),
      results: { data: [{ a: 1 }] },
    } as unknown as QueryResponse;
    const largeQuery = {
      ...queries[1],
      startDttm: Date.now(),
      results: {
        data: [
          {
            jsonValue: `{"str":"${new Array(
              (LOCALSTORAGE_MAX_QUERY_RESULTS_KB / BYTES_PER_CHAR) * KB_STORAGE,
            )
              .fill(0)
              .join('')}"}`,
          },
        ],
      },
    } as unknown as QueryResponse;
    expect(Object.keys(largeQuery.results)).toContain('data');
    const emptiedQuery = emptyQueryResults({
      [reasonableSizeQuery.id]: reasonableSizeQuery,
      [largeQuery.id]: largeQuery,
    });
    expect(emptiedQuery[largeQuery.id].results).toEqual({});
    expect(emptiedQuery[reasonableSizeQuery.id].results).toEqual(
      reasonableSizeQuery.results,
    );
  });

  test('should only return selected keys for query editor', () => {
    const queryEditors = [{ ...defaultQueryEditor, dummy: 'value' }];
    expect(Object.keys(queryEditors[0])).toContain('dummy');

    const clearedQueryEditors = clearQueryEditors(queryEditors);
    expect(Object.keys(clearedQueryEditors[0])).toContain('version');
    expect(Object.keys(clearedQueryEditors[0])).not.toContain('dummy');
  });
});