Add custom saved queries and fix duplicate requests

CHANGELOG.md

@@ -25,6 +25,7 @@ All notable changes to the Wazuh app project will be documented in this file.
 - Fixed style when unnpinned an agent in endpoint summary section [#7015](https://github.com/wazuh/wazuh-dashboard-plugins/pull/7015)
 - Fixed overflow style on a long value filter [#7021](https://github.com/wazuh/wazuh-dashboard-plugins/pull/7021)
 - Fixed buttons enabled for a readonly user in `Endpoint groups` section [#7056](https://github.com/wazuh/wazuh-dashboard-plugins/pull/7056)
+- Fixed the automatic page refresh in dashboards and prevent duplicate requests [#7090](https://github.com/wazuh/wazuh-dashboard-plugins/pull/7090)
 
 ### Changed
 

plugins/main/common/constants.ts

@@ -528,3 +528,6 @@ export const SEARCH_BAR_DEBOUNCE_UPDATE_TIME = 400;
 
 // ID used to refer the createOsdUrlStateStorage state
 export const OSD_URL_STATE_STORAGE_ID = 'state:storeInSessionStorage';
+
+export const APP_STATE_URL_KEY = '_a';
+export const GLOBAL_STATE_URL_KEY = '_g';

plugins/main/public/components/common/data-source/hooks/use-data-source.ts

@@ -98,7 +98,6 @@ export function useDataSource<
   const {
     filters: initialFilters = [...defaultFilters],
     fetchFilters: initialFetchFilters = [],
-    fixedFilters: initialFixedFilters = [],
     DataSource: DataSourceConstructor,
     repository,
     factory: injectedFactory,

plugins/main/public/components/common/hooks/saved_query/clear_saved_query.test.ts

@@ -0,0 +1,48 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Any modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. 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 { clearStateFromSavedQuery } from './clear_saved_query';
+
+import { dataPluginMock } from '../../../../../../../src/plugins/data/public/mocks';
+import { DataPublicPluginStart } from '../../../../../../../src/plugins/data/public';
+
+describe('clearStateFromSavedQuery', () => {
+  let dataMock: jest.Mocked<DataPublicPluginStart>;
+
+  beforeEach(() => {
+    dataMock = dataPluginMock.createStartContract();
+  });
+
+  it('should clear filters and query', async () => {
+    dataMock.query.filterManager.removeAll = jest.fn();
+    clearStateFromSavedQuery(dataMock.query);
+    expect(dataMock.query.queryString.clearQuery).toHaveBeenCalled();
+  });
+});

plugins/main/public/components/common/hooks/saved_query/clear_saved_query.ts

@@ -0,0 +1,35 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Any modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. 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 { QueryStart } from '../../../../../../../src/plugins/data/public';
+
+export const clearStateFromSavedQuery = (queryService: QueryStart) => {
+  queryService.queryString.clearQuery();
+};

plugins/main/public/components/common/hooks/saved_query/constants.ts

@@ -0,0 +1 @@
+export const SAVED_QUERY = 'savedQuery';

plugins/main/public/components/common/hooks/saved_query/populate_state_from_saved_query.test.ts

@@ -0,0 +1,126 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Any modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. 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 { populateStateFromSavedQuery } from './populate_state_from_saved_query';
+
+import { dataPluginMock } from '../../../../../../../src/plugins/data/public/mocks';
+import { DataPublicPluginStart } from '../../../../../../../src/plugins/data/public';
+import { SavedQuery } from '../../../../../../../src/plugins/data/public/query/saved_query/types';
+import { FilterStateStore } from '../../../../../../../src/plugins/data/common/opensearch_query/filters/meta_filter';
+import { getFilter } from '../../../../../../../src/plugins/data/public/query/filter_manager/test_helpers/get_stub_filter';
+
+describe('populateStateFromSavedQuery', () => {
+  let dataMock: jest.Mocked<DataPublicPluginStart>;
+
+  const baseSavedQuery: SavedQuery = {
+    id: 'test',
+    attributes: {
+      title: 'test',
+      description: 'test',
+      query: {
+        query: 'test',
+        language: 'kuery',
+      },
+    },
+  };
+
+  beforeEach(() => {
+    dataMock = dataPluginMock.createStartContract();
+    dataMock.query.filterManager.setFilters = jest.fn();
+    dataMock.query.filterManager.getGlobalFilters = jest
+      .fn()
+      .mockReturnValue([]);
+  });
+
+  it('should set query', async () => {
+    const savedQuery: SavedQuery = {
+      ...baseSavedQuery,
+    };
+    populateStateFromSavedQuery(dataMock.query, savedQuery);
+    expect(dataMock.query.queryString.setQuery).toHaveBeenCalled();
+  });
+
+  it('should set filters', async () => {
+    const savedQuery: SavedQuery = {
+      ...baseSavedQuery,
+    };
+    const f1 = getFilter(FilterStateStore.APP_STATE, false, false, 'age', 34);
+    savedQuery.attributes.filters = [f1];
+    populateStateFromSavedQuery(dataMock.query, savedQuery);
+    expect(dataMock.query.queryString.setQuery).toHaveBeenCalled();
+  });
+
+  it('should preserve global filters', async () => {
+    const globalFilter = getFilter(
+      FilterStateStore.GLOBAL_STATE,
+      false,
+      false,
+      'age',
+      34,
+    );
+    dataMock.query.filterManager.getGlobalFilters = jest
+      .fn()
+      .mockReturnValue([globalFilter]);
+    const savedQuery: SavedQuery = {
+      ...baseSavedQuery,
+    };
+    const f1 = getFilter(FilterStateStore.APP_STATE, false, false, 'age', 34);
+    savedQuery.attributes.filters = [f1];
+    populateStateFromSavedQuery(dataMock.query, savedQuery);
+    expect(dataMock.query.queryString.setQuery).toHaveBeenCalled();
+  });
+
+  it('should update timefilter', async () => {
+    const savedQuery: SavedQuery = {
+      ...baseSavedQuery,
+    };
+    savedQuery.attributes.timefilter = {
+      from: '2018',
+      to: '2019',
+      refreshInterval: {
+        pause: true,
+        value: 10,
+      },
+    };
+
+    dataMock.query.timefilter.timefilter.setTime = jest.fn();
+    dataMock.query.timefilter.timefilter.setRefreshInterval = jest.fn();
+
+    populateStateFromSavedQuery(dataMock.query, savedQuery);
+
+    expect(dataMock.query.timefilter.timefilter.setTime).toHaveBeenCalledWith({
+      from: savedQuery.attributes.timefilter.from,
+      to: savedQuery.attributes.timefilter.to,
+    });
+    expect(
+      dataMock.query.timefilter.timefilter.setRefreshInterval,
+    ).toHaveBeenCalledWith(savedQuery.attributes.timefilter.refreshInterval);
+  });
+});

plugins/main/public/components/common/hooks/saved_query/populate_state_from_saved_query.ts

@@ -0,0 +1,60 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Any modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. 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 {
+  Filter,
+  QueryStart,
+  SavedQuery,
+} from '../../../../../../../src/plugins/data/public';
+
+export const populateStateFromSavedQuery = (
+  queryService: QueryStart,
+  savedQuery: SavedQuery,
+) => {
+  const {
+    timefilter: { timefilter },
+    queryString,
+  } = queryService;
+  // timefilter
+  if (savedQuery.attributes.timefilter) {
+    timefilter.setTime({
+      from: savedQuery.attributes.timefilter.from,
+      to: savedQuery.attributes.timefilter.to,
+    });
+    if (savedQuery.attributes.timefilter.refreshInterval) {
+      timefilter.setRefreshInterval(
+        savedQuery.attributes.timefilter.refreshInterval,
+      );
+    }
+  }
+
+  // query string
+  queryString.setQuery(savedQuery.attributes.query);
+};