@itwin/reports-config-widget-react 0.4.0 → 0.5.0

package/src/test/Reports.test.tsx

@@ -12,13 +12,11 @@ import {
 } from "../test/test-utils";
 import { Reports } from "../widget/components/Reports";
 import { ReportsConfigWidget } from "../ReportsConfigWidget";
-import { rest } from "msw";
-import { setupServer } from "msw/node";
 import faker from "@faker-js/faker";
-import type { ReportCollection } from "@itwin/insights-client";
+import type { ReportCollection, ReportsClient } from "@itwin/insights-client";
 import userEvent from "@testing-library/user-event";
-import { REPORTS_CONFIG_BASE_URL } from "../widget/ReportsConfigUiProvider";
 import { EmptyLocalization } from "@itwin/core-common";
+import * as moq from "typemoq";
 
 const reportsFactory = (): ReportCollection => ({
   reports: Array.from(
@@ -43,38 +41,30 @@ const reportsFactory = (): ReportCollection => ({
   },
 });
 
-const server = setupServer();
+const mockGetReports = jest.fn();
+const mockDeleteReport = jest.fn();
+
+const mockReportsClient = moq.Mock.ofType<ReportsClient>();
 
 beforeAll(async () => {
   const localization = new EmptyLocalization();
   await ReportsConfigWidget.initialize(localization);
-  server.listen();
-});
 
-afterAll(() => {
-  server.close();
+  mockReportsClient.setup(async (x) => x.getReports(moq.It.isAny(), moq.It.isAny())).returns(mockGetReports);
+  mockReportsClient.setup(async (x) => x.deleteReport(moq.It.isAny(), moq.It.isAny())).returns(mockDeleteReport);
 });
 
-afterEach(() => server.resetHandlers());
+afterEach(() => {
+  mockGetReports.mockReset();
+  mockDeleteReport.mockReset();
+});
 
 describe("Reports View", () => {
   it("call to action button should be clickable with no reports", async () => {
-    server.use(
-      rest.get(
-        `${REPORTS_CONFIG_BASE_URL}/insights/reporting/reports`,
-        async (_req, res, ctx) => {
-          return res(
-            ctx.delay(500),
-            ctx.status(200),
-            ctx.json({ reports: [] })
-          );
-        }
-      )
-    );
-
+    mockGetReports.mockReturnValueOnce([]);
     const onClickAddMock = jest.fn();
 
-    const { user } = render(<Reports onClickAddReport={onClickAddMock} />);
+    const { user } = render(<Reports onClickAddReport={onClickAddMock} />, { reportsClient: mockReportsClient.object });
 
     await waitForElementToBeRemoved(() => screen.getByText(/loading/i));
     const ctaButton = screen.getByRole("button", {
@@ -85,21 +75,10 @@ describe("Reports View", () => {
   });
 
   it("be able to add new report", async () => {
-    server.use(
-      rest.get(
-        `${REPORTS_CONFIG_BASE_URL}/insights/reporting/reports`,
-        async (_req, res, ctx) => {
-          return res(
-            ctx.delay(500),
-            ctx.status(200),
-            ctx.json({ reports: [] })
-          );
-        }
-      )
-    );
+    mockGetReports.mockReturnValueOnce([]);
 
     const onClickAddMock = jest.fn();
-    const { user } = render(<Reports onClickAddReport={onClickAddMock} />);
+    const { user } = render(<Reports onClickAddReport={onClickAddMock} />,  { reportsClient: mockReportsClient.object });
 
     await waitForElementToBeRemoved(() => screen.getByText(/loading/i));
     const newButton = screen.getByRole("button", {
@@ -111,16 +90,9 @@ describe("Reports View", () => {
 
   it("list all reports", async () => {
     const mockedReports: ReportCollection = reportsFactory();
-    server.use(
-      rest.get(
-        `${REPORTS_CONFIG_BASE_URL}/insights/reporting/reports`,
-        async (_req, res, ctx) => {
-          return res(ctx.delay(500), ctx.status(200), ctx.json(mockedReports));
-        }
-      )
-    );
+    mockGetReports.mockReturnValueOnce(mockedReports.reports);
 
-    render(<Reports />);
+    render(<Reports />,  { reportsClient: mockReportsClient.object });
 
     await waitForElementToBeRemoved(() => screen.getByText(/loading/i));
     const horizontalTiles = screen.getAllByTestId("horizontal-tile");
@@ -144,16 +116,9 @@ describe("Reports View", () => {
 
   it("able to modify a report", async () => {
     const mockedReports: ReportCollection = reportsFactory();
-    server.use(
-      rest.get(
-        `${REPORTS_CONFIG_BASE_URL}/insights/reporting/reports`,
-        async (_req, res, ctx) => {
-          return res(ctx.delay(500), ctx.status(200), ctx.json(mockedReports));
-        }
-      )
-    );
+    mockGetReports.mockReturnValueOnce(mockedReports.reports);
     const onClickModifyMock = jest.fn();
-    const { user } = render(<Reports onClickReportModify={onClickModifyMock} />);
+    const { user } = render(<Reports onClickReportModify={onClickModifyMock} />,  { reportsClient: mockReportsClient.object });
 
     await waitForElementToBeRemoved(() => screen.getByText(/loading/i));
 
@@ -169,27 +134,10 @@ describe("Reports View", () => {
 
   it("remove a report", async () => {
     const mockedReports: ReportCollection = reportsFactory();
-    const mockedReportsOriginalLength = mockedReports.reports.length;
-    server.use(
-      rest.get(
-        `${REPORTS_CONFIG_BASE_URL}/insights/reporting/reports`,
-        async (_req, res, ctx) => {
-          return res(ctx.delay(200), ctx.status(200), ctx.json(mockedReports));
-        }
-      ),
-      rest.delete(
-        `${REPORTS_CONFIG_BASE_URL}/insights/reporting/reports/${mockedReports.reports[0].id
-        }`,
-        async (_req, res, ctx) => {
-          mockedReports.reports = mockedReports.reports.filter(
-            (report) => report.id !== mockedReports.reports[0].id
-          );
-          return res(ctx.delay(100), ctx.status(204));
-        }
-      )
-    );
 
-    const { user } = render(<Reports />);
+    mockGetReports.mockReturnValue(mockedReports.reports);
+
+    const { user } = render(<Reports />,  { reportsClient: mockReportsClient.object });
 
     await waitForElementToBeRemoved(() => screen.getByText(/loading/i));
 
@@ -208,29 +156,17 @@ describe("Reports View", () => {
 
     await user.click(deleteButton);
 
-    await waitForElementToBeRemoved(() =>
-      screen.getByTestId(/rcw-loading-delete/i)
-    );
     await waitForElementToBeRemoved(() => screen.getByRole("dialog"));
 
-    // Should be one less report
-    expect(screen.getAllByTestId("horizontal-tile")).toHaveLength(
-      mockedReportsOriginalLength - 1
-    );
+    expect(mockDeleteReport).toBeCalled();
+    // Two calls, when it is first rendered and when it is refreshed.
+    expect(mockGetReports).toBeCalledTimes(2);
   });
 
   it("search for a report", async () => {
     const mockedReports: ReportCollection = reportsFactory();
-    server.use(
-      rest.get(
-        `${REPORTS_CONFIG_BASE_URL}/insights/reporting/reports`,
-        async (_req, res, ctx) => {
-          return res(ctx.delay(200), ctx.status(200), ctx.json(mockedReports));
-        }
-      )
-    );
-
-    const { user } = render(<Reports />);
+    mockGetReports.mockReturnValueOnce(mockedReports.reports);
+    const { user } = render(<Reports />, { reportsClient: mockReportsClient.object });
 
     await waitForElementToBeRemoved(() => screen.getByText(/loading/i));
 
@@ -265,16 +201,9 @@ describe("Reports View", () => {
 
   it("modify a report", async () => {
     const mockedReports: ReportCollection = reportsFactory();
-    server.use(
-      rest.get(
-        `${REPORTS_CONFIG_BASE_URL}/insights/reporting/reports`,
-        async (_req, res, ctx) => {
-          return res(ctx.delay(200), ctx.status(200), ctx.json(mockedReports));
-        }
-      )
-    );
+    mockGetReports.mockReturnValueOnce(mockedReports.reports);
     const onClickModifyMock = jest.fn();
-    const { user } = render(<Reports onClickReportModify={onClickModifyMock} />);
+    const { user } = render(<Reports onClickReportModify={onClickModifyMock} />,  { reportsClient: mockReportsClient.object });
 
     await waitForElementToBeRemoved(() => screen.getByText(/loading/i));
 
@@ -289,16 +218,9 @@ describe("Reports View", () => {
 
   it("click a report", async () => {
     const mockedReports: ReportCollection = reportsFactory();
-    server.use(
-      rest.get(
-        `${REPORTS_CONFIG_BASE_URL}/insights/reporting/reports`,
-        async (_req, res, ctx) => {
-          return res(ctx.delay(200), ctx.status(200), ctx.json(mockedReports));
-        }
-      )
-    );
+    mockGetReports.mockReturnValueOnce(mockedReports.reports);
     const onClickTitleMock = jest.fn();
-    const { user } = render(<Reports onClickReportTitle={onClickTitleMock} />);
+    const { user } = render(<Reports onClickReportTitle={onClickTitleMock} />,  { reportsClient: mockReportsClient.object });
 
     await waitForElementToBeRemoved(() => screen.getByText(/loading/i));
 

package/src/test/test-utils.tsx

@@ -7,13 +7,74 @@ import { render as rtlRender } from "@testing-library/react";
 import userEvent from "@testing-library/user-event";
 import type { ReportsConfigContextProps } from "../widget/components/ReportsConfigContext";
 import { ReportsConfigContext } from "../widget/components/ReportsConfigContext";
+import { IModelState } from "@itwin/imodels-client-management";
 
 export const mockAccessToken = async () => "Bearer eyJhbGci";
 
+export const mockIModelId1 = "mockIModelId1";
+export const mockIModelId2 = "mockIModelId2";
+
+export const mockReportId = "mockReportId";
+export const mockITwinId: string = "mockiTwinId";
+
+export const mockIModelsResponse = [
+  {
+    iModel: {
+      id: mockIModelId1,
+      displayName: "rAnDoMdIsPlAynAmE1",
+      name: "rAnDomName1",
+      description: "rAnDoMDeScRiPtIoN1",
+      createdDateTime: "2021-10-04T22:13:50.397Z",
+      state: IModelState.Initialized,
+      iTwinId: mockITwinId,
+      extent: null,
+      getCreator: async () => undefined,
+      _links: {
+        creator: {
+          href: "",
+        },
+        namedVersions: {
+          href: "",
+        },
+        changesets: {
+          href: "",
+        },
+        upload: undefined,
+        complete: undefined,
+      },
+    },
+  },
+  {
+    iModel: {
+      id: mockIModelId2,
+      displayName: "rAnDoMdIsPlAynAmE2",
+      name: "rAnDomName2",
+      description: "rAnDoMDeScRiPtIoN2",
+      createdDateTime: "2021-10-04T22:13:50.397Z",
+      state: IModelState.Initialized,
+      iTwinId: mockITwinId,
+      extent: null,
+      getCreator: async () => undefined,
+      _links: {
+        creator: {
+          href: "",
+        },
+        namedVersions: {
+          href: "",
+        },
+        changesets: {
+          href: "",
+        },
+        upload: undefined,
+        complete: undefined,
+      },
+    },
+  },
+];
+
 interface WrapperProps {
   children?: React.ReactNode;
 }
-export const mockITwinId: string = "mockiTwinId";
 
 function render(ui: React.ReactElement, contextProps?: Partial<ReportsConfigContextProps>, { ...options } = {}) {
   const Wrapper = ({ children }: WrapperProps) => (

package/src/widget/components/Constants.ts

@@ -5,3 +5,5 @@
 export const STATUS_CHECK_INTERVAL = 5000;
 export const ANIMATION_DELAY = "5s";
 export const ANIMATION_DURATION = "1s";
+
+export const IMODELS_BASE_URL= "https://api.bentley.com/imodels";

package/src/widget/components/ReportsConfigContext.tsx

@@ -4,7 +4,7 @@
 *--------------------------------------------------------------------------------------------*/
 import { IModelApp } from "@itwin/core-frontend";
 import type { IModelsClientOptions } from "@itwin/imodels-client-management";
-import { Constants, IModelsClient } from "@itwin/imodels-client-management";
+import { IModelsClient } from "@itwin/imodels-client-management";
 import { ExtractionClient, MappingsClient, REPORTING_BASE_PATH, ReportsClient } from "@itwin/insights-client";
 import { toaster } from "@itwin/itwinui-react";
 import React, { useCallback, useEffect, useMemo, useState } from "react";
@@ -16,6 +16,7 @@ import type {
 import { ReportsConfigApiContext } from "../context/ReportsConfigApiContext";
 import { REPORTS_CONFIG_BASE_URL } from "../ReportsConfigUiProvider";
 import { BulkExtractor } from "./BulkExtractor";
+import { IMODELS_BASE_URL } from "./Constants";
 import { FailedExtractionToast, SuccessfulExtractionToast } from "./ExtractionToast";
 import { generateUrl } from "./utils";
 
@@ -40,7 +41,7 @@ export const ReportsConfigContext = (props: ReportsConfigContextProps) => {
     props.baseUrl || REPORTS_CONFIG_BASE_URL
   ), [props.baseUrl]);
   const iModelClientOptions: IModelsClientOptions = useMemo(() => ({
-    api: { baseUrl: generateUrl(Constants.api.baseUrl, props.baseUrl ?? REPORTS_CONFIG_BASE_URL) },
+    api: { baseUrl: generateUrl(IMODELS_BASE_URL, props.baseUrl ?? REPORTS_CONFIG_BASE_URL) },
   }), [props.baseUrl]);
   const [extractionClient, setExtractionClient] = useState<ExtractionClient>(
     props.extractionClient ?? new ExtractionClient(reportsBaseUrl())

package/src/widget/components/SelectIModel.tsx

@@ -27,7 +27,7 @@ const fetchIModels = async (
   const accessToken = await getAccessToken();
   const authorization = AccessTokenAdapter.toAuthorizationCallback(accessToken);
   const getiModelListParams: GetIModelListParams = {
-    urlParams: { projectId: iTwinId },
+    urlParams: { iTwinId },
     authorization,
   };
   const iModels = await toArray(

package/.rush/temp/operation/rebuild/all.log

@@ -1,9 +0,0 @@
-Invoking: npm run clean && npm run build 
-
-> @itwin/reports-config-widget-react@0.3.0 clean
-> rimraf lib
-
-
-> @itwin/reports-config-widget-react@0.3.0 build
-> npm run -s dual-build && npm run -s copy:assets
-

package/.rush/temp/operation/rebuild/state.json

@@ -1,3 +0,0 @@
-{
-  "nonCachedDurationMs": 32635.269864999984
-}

package/.rush/temp/package-deps_rebuild.json

@@ -1,68 +0,0 @@
-{
-  "files": {
-    "packages/itwin/reports-config-widget/CHANGELOG.json": "e4222db5e08a9732dccb6128b0cff08d317ffe75",
-    "packages/itwin/reports-config-widget/CHANGELOG.md": "1a9bb4cb07d6e27d86b32b1980fffb2ab9e6f349",
-    "packages/itwin/reports-config-widget/LICENSE.md": "a5ca7f3cac799edf91ab2cadfe98eca41db76415",
-    "packages/itwin/reports-config-widget/README.md": "6b69338893db9df6210813dd1bc09e9aacda7167",
-    "packages/itwin/reports-config-widget/__mocks__/fileMock.js": "fc9379f960161b8723da71342c5ef74a7e6946fe",
-    "packages/itwin/reports-config-widget/jest.config.js": "abc87b772d7ae1cb045a37b4709545b638faa210",
-    "packages/itwin/reports-config-widget/package.json": "c740d601de20245bb920fa5a911f690dae173a8a",
-    "packages/itwin/reports-config-widget/public/locales/en/ReportsConfigWidget.json": "f7e47c2e85a78037030bb1f471ad0d1e6c261763",
-    "packages/itwin/reports-config-widget/src/ReportsConfigWidget.ts": "2a14eac2207411b012e8f337887b66da02011173",
-    "packages/itwin/reports-config-widget/src/reports-config-widget-react.ts": "299cd7ed134783bcc2f207ee446333fb05595daf",
-    "packages/itwin/reports-config-widget/src/test/AddMappingModal.test.tsx": "9d1111a8d1f74de5b7791c166ae4cbdf6bc2d5f1",
-    "packages/itwin/reports-config-widget/src/test/BulkExtractor.test.ts": "c909990e627c5967a5f9937f10f4b6e97dc25122",
-    "packages/itwin/reports-config-widget/src/test/DeleteModal.test.tsx": "be9d8075f1523eba6d32518525a56851236174dd",
-    "packages/itwin/reports-config-widget/src/test/ReportAction.test.tsx": "ea98e31611e11770027f01f92d3ccee0640dd71d",
-    "packages/itwin/reports-config-widget/src/test/ReportMappingHorizontalTile.test.tsx": "323bdb87994092a2615548b9d1ce8cea8c0680b6",
-    "packages/itwin/reports-config-widget/src/test/ReportMappings.test.tsx": "52a03c084756f50716aa61bd9aa677bbe035be86",
-    "packages/itwin/reports-config-widget/src/test/Reports.test.tsx": "be8e44a9667b9d7857077cd4c3035bd2856da9fb",
-    "packages/itwin/reports-config-widget/src/test/WidgetHeader.test.tsx": "cc281c4831f84f40b023b9ed926c06e37d5d2699",
-    "packages/itwin/reports-config-widget/src/test/test-utils.tsx": "e16983f1a5bcb83c31fa6f663849d8ce4ee3109b",
-    "packages/itwin/reports-config-widget/src/widget/ReportsConfigUiProvider.tsx": "9b531c7129d568304d77a6dd7e47782d1f66932e",
-    "packages/itwin/reports-config-widget/src/widget/components/ActionPanel.scss": "634c4805de2389fa7249dedbbf76127326f29826",
-    "packages/itwin/reports-config-widget/src/widget/components/ActionPanel.tsx": "858ac36de97251b10c11602289d6ff94633fb299",
-    "packages/itwin/reports-config-widget/src/widget/components/AddMappingsModal.scss": "ac352ebd17b6affd7df16242fd52649154b788a3",
-    "packages/itwin/reports-config-widget/src/widget/components/AddMappingsModal.tsx": "bb3e168837fd1d9129b7e25d75dd9448a0f5dd0d",
-    "packages/itwin/reports-config-widget/src/widget/components/BulkExtractor.ts": "8e164d7e9517228921ec5651abca87435f7d7801",
-    "packages/itwin/reports-config-widget/src/widget/components/Constants.ts": "ef6582f3ed64ee3b1a5f6048ba6cded5714a9b4b",
-    "packages/itwin/reports-config-widget/src/widget/components/DeleteModal.scss": "53c38196a84cc1705e26f69b3f7fb599ecbc77e6",
-    "packages/itwin/reports-config-widget/src/widget/components/DeleteModal.tsx": "f8beb2148e0bbf80f127c60b28260d5e489007c4",
-    "packages/itwin/reports-config-widget/src/widget/components/ExtractionStates/FailedExtractionState.tsx": "9403b3aa194a9b9148d305e8d59934b5de850583",
-    "packages/itwin/reports-config-widget/src/widget/components/ExtractionStates/QueuedExtractionState.tsx": "924f3c2e3a51400ca26184cd90c9632f5856d162",
-    "packages/itwin/reports-config-widget/src/widget/components/ExtractionStates/RunningExtractionState.tsx": "f53d96def4e7fc3819516228aed71e6f50f19b3e",
-    "packages/itwin/reports-config-widget/src/widget/components/ExtractionStates/StartingExtractionState.tsx": "8f75f1ef77ca17307b8133835cd48941ed599020",
-    "packages/itwin/reports-config-widget/src/widget/components/ExtractionStates/SucceededExtractionState.tsx": "4d7a51bb6afcd2032786d3dd16b5ca37ddb6a8c4",
-    "packages/itwin/reports-config-widget/src/widget/components/ExtractionStatus.scss": "5da807d7280a472d121a152454f2f9e8557adf3f",
-    "packages/itwin/reports-config-widget/src/widget/components/ExtractionStatus.tsx": "263d7650c2bb36cf0f7a4564777ee022c9b752e3",
-    "packages/itwin/reports-config-widget/src/widget/components/ExtractionToast.tsx": "1f1164bab145a48236eea596a9232aaa41cc36f0",
-    "packages/itwin/reports-config-widget/src/widget/components/HorizontalTile.scss": "8c6061fb6c4169ffa4615716ec19869bca69dee3",
-    "packages/itwin/reports-config-widget/src/widget/components/HorizontalTile.tsx": "6848c58298f266e078b401e7a8658fbf8911ea7e",
-    "packages/itwin/reports-config-widget/src/widget/components/LocalizedTablePaginator.tsx": "69c8a6b511f04f67eed0a6e7bbfd2a2f881c9a09",
-    "packages/itwin/reports-config-widget/src/widget/components/ReportAction.scss": "75f999be885914aef6f1e60d46eed3350c77d8f5",
-    "packages/itwin/reports-config-widget/src/widget/components/ReportAction.tsx": "dacb7535edc76c2c507b73dcb45cc4b2a1b956a1",
-    "packages/itwin/reports-config-widget/src/widget/components/ReportHorizontalTile.tsx": "af36e76b44d7d83502e9cd8c98090a06a96c5d13",
-    "packages/itwin/reports-config-widget/src/widget/components/ReportMappingHorizontalTile.tsx": "e7e9dc7155f64ce1d2ebaf26a0edcb6d3c142018",
-    "packages/itwin/reports-config-widget/src/widget/components/ReportMappings.scss": "f926a32a26b124414f826ddd18a30fb86719b998",
-    "packages/itwin/reports-config-widget/src/widget/components/ReportMappings.tsx": "e2914c3ef7d2b22af2f00bbcc8e734199600967e",
-    "packages/itwin/reports-config-widget/src/widget/components/Reports.scss": "27a024479c935ce7cbecda97e7dca77175fa0291",
-    "packages/itwin/reports-config-widget/src/widget/components/Reports.tsx": "61e15d1b1462415604ab3793f1db742151d65794",
-    "packages/itwin/reports-config-widget/src/widget/components/ReportsConfigContext.tsx": "016a9bcd394013bb6210ba82fd5b545e3a2e009f",
-    "packages/itwin/reports-config-widget/src/widget/components/ReportsContainer.scss": "e1b6def71cb38d37e33b771c47d8cabae7295f13",
-    "packages/itwin/reports-config-widget/src/widget/components/ReportsContainer.tsx": "3616b11fa49d56987bb0e942ae1da1c55773ecb4",
-    "packages/itwin/reports-config-widget/src/widget/components/ReportsHeader.tsx": "9096926806c177c77e10c9b68080ff7c1c97eec9",
-    "packages/itwin/reports-config-widget/src/widget/components/ReportsRouter.tsx": "7729f452bfed080ed6c4e323eb4eb44a4b2ee9c9",
-    "packages/itwin/reports-config-widget/src/widget/components/SearchBar.scss": "db46573c5c3efd17ec336315c63dd992a27b2ffa",
-    "packages/itwin/reports-config-widget/src/widget/components/SearchBar.tsx": "d2a868ec3a7b8581595a48dd0aeb63662a97aaec",
-    "packages/itwin/reports-config-widget/src/widget/components/SelectIModel.scss": "b9014feb9cc639566a6aac385b94fccae0e540ef",
-    "packages/itwin/reports-config-widget/src/widget/components/SelectIModel.tsx": "6f93e10375aeb0fd9200cc37b8c578874a995fad",
-    "packages/itwin/reports-config-widget/src/widget/components/utils.scss": "7cff2d692889478f8238fe28b8648fb6edb0e803",
-    "packages/itwin/reports-config-widget/src/widget/components/utils.tsx": "7324debaf03e9a53516172df46a62a6fc561217d",
-    "packages/itwin/reports-config-widget/src/widget/context/BulkExtractorContext.tsx": "e38bdedd3deb30a9d2f9097e7873be4f88b72669",
-    "packages/itwin/reports-config-widget/src/widget/context/ReportsConfigApiContext.tsx": "ffb4810353380a198a83c449749ed269eba3e2a3",
-    "packages/itwin/reports-config-widget/src/widget/hooks/useValidator.ts": "2d417ccb90ad0f0af05aba0edec574a641cd8ad9",
-    "packages/itwin/reports-config-widget/tsconfig.json": "6242b8ae656509b508caf769d158dcfec0a0b6ec",
-    "packages/itwin/reports-config-widget/.rush/temp/shrinkwrap-deps.json": "252533a4f04526f15c289baddd7da126da8c8f63"
-  },
-  "arguments": "npm run clean && npm run build "
-}