From e85030902fbb454f26c7d58214e50e2c78eb38c8 Mon Sep 17 00:00:00 2001
From: Navaneeth Suresh <navaneeths1998@gmail.com>
Date: Fri, 25 Sep 2020 00:24:02 +0530
Subject: [PATCH] Add a message if techdocs takes long time to load

---
 .../techdocs/src/reader/components/Reader.tsx |  5 +-
 .../components/TechDocsProgressBar.test.tsx   | 36 +++++++++++++
 .../reader/components/TechDocsProgressBar.tsx | 50 +++++++++++++++++++
 3 files changed, 89 insertions(+), 2 deletions(-)
 create mode 100644 plugins/techdocs/src/reader/components/TechDocsProgressBar.test.tsx
 create mode 100644 plugins/techdocs/src/reader/components/TechDocsProgressBar.tsx

diff --git a/plugins/techdocs/src/reader/components/Reader.tsx b/plugins/techdocs/src/reader/components/Reader.tsx
index 2aa87ea1ee..f2c6d1e2da 100644
--- a/plugins/techdocs/src/reader/components/Reader.tsx
+++ b/plugins/techdocs/src/reader/components/Reader.tsx
@@ -15,7 +15,7 @@
  */
 
 import React from 'react';
-import { useApi, Progress } from '@backstage/core';
+import { useApi } from '@backstage/core';
 import { useShadowDom } from '..';
 import { useAsync } from 'react-use';
 import { techdocsStorageApiRef } from '../../api';
@@ -23,6 +23,7 @@ import { useParams, useNavigate } from 'react-router-dom';
 import { ParsedEntityId } from '../../types';
 import { useTheme } from '@material-ui/core';
 import { BackstageTheme } from '@backstage/theme';
+import TechDocsProgressBar from './TechDocsProgressBar';
 
 import transformer, {
   addBaseUrl,
@@ -150,7 +151,7 @@ export const Reader = ({ entityId }: Props) => {
 
   return (
     <>
-      {loading ? <Progress /> : null}
+      {loading ? <TechDocsProgressBar /> : null}
       <div ref={shadowDomRef} />
     </>
   );
diff --git a/plugins/techdocs/src/reader/components/TechDocsProgressBar.test.tsx b/plugins/techdocs/src/reader/components/TechDocsProgressBar.test.tsx
new file mode 100644
index 0000000000..be464bd485
--- /dev/null
+++ b/plugins/techdocs/src/reader/components/TechDocsProgressBar.test.tsx
@@ -0,0 +1,36 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * 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 TechDocsProgressBar from './TechDocsProgressBar';
+import React from 'react';
+import { render } from '@testing-library/react';
+import { wrapInTestApp } from '@backstage/test-utils';
+import { act } from 'react-dom/test-utils';
+
+jest.useFakeTimers();
+
+describe('<TechDocsProgressBar />', () => {
+  it('should render a message if techdocs page takes more time to load', () => {
+    const rendered = render(wrapInTestApp(<TechDocsProgressBar />));
+
+    expect(rendered.getByTestId('progress')).toBeDefined();
+    expect(rendered.queryByTestId('delay-reason')).toBeNull();
+    act(() => {
+      jest.advanceTimersByTime(5000);
+    });
+    expect(rendered.getByTestId('delay-reason')).toBeDefined();
+  });
+});
diff --git a/plugins/techdocs/src/reader/components/TechDocsProgressBar.tsx b/plugins/techdocs/src/reader/components/TechDocsProgressBar.tsx
new file mode 100644
index 0000000000..c7caa125bc
--- /dev/null
+++ b/plugins/techdocs/src/reader/components/TechDocsProgressBar.tsx
@@ -0,0 +1,50 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * 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 React, { useState, useEffect } from 'react';
+import { useMountedState } from 'react-use';
+import { Progress } from '@backstage/core';
+import { Typography } from '@material-ui/core';
+
+const TechDocsProgressBar = () => {
+  const isMounted = useMountedState();
+  const [hasBeenDelayed, setHasBeenDelayed] = useState(false);
+
+  const delayReason = `Docs are still loading...Backstage takes some extra time to load docs
+  for the first time. The subsequent loads are much faster.`;
+
+  // Allowed time that docs can take to load (in milliseconds)
+  const allowedDelayTime = 5000;
+
+  useEffect(() => {
+    setTimeout(() => {
+      if (isMounted()) {
+        setHasBeenDelayed(true);
+      }
+    }, allowedDelayTime);
+  });
+
+  return (
+    <>
+      {hasBeenDelayed ? (
+        <Typography data-testid="delay-reason">{delayReason}</Typography>
+      ) : null}
+      <Progress />
+    </>
+  );
+};
+
+export default TechDocsProgressBar;