Merge pull request #7573 from sagemathinc/r-ide

williamstein · web-flow · commit 3a4e712a088e · 2024-05-28T06:27:28.000-07:00
"R IDE" string
diff --git a/src/packages/comm/x11-apps.ts b/src/packages/comm/x11-apps.ts
@@ -4,6 +4,7 @@
  */
 
 //import { IconName } from "@cocalc/frontend/components/icon";
+import { R_IDE } from "@cocalc/util/consts/ui";
 
 interface APPS_Interface {
   [k: string]: {
@@ -102,8 +103,8 @@ export const APPS: Readonly<APPS_Interface> = Object.freeze({
   },
   rstudio: {
     icon: "r",
-    desc: "An integrated development environment (IDE) for R.  RStudio, Inc. is in no way affiliated with CoCalc",
-    label: "RStudio",
+    desc: "An integrated development environment (IDE) for R. Posit Software, PBC (formerly RStudio, PBC) is in no way affiliated with CoCalc",
+    label: R_IDE,
   },
   /* See https://github.com/sagemathinc/cocalc/issues/5427
   Sometimes, Octave GUI works, sometimes not.
diff --git a/src/packages/frontend/account/delete-account.tsx b/src/packages/frontend/account/delete-account.tsx
@@ -3,9 +3,14 @@
  *  License: AGPLv3 s.t. "Commons Clause" – see LICENSE.md for details
  */
 
-import { Component, React, Rendered, rtypes } from "../app-framework";
-import { Button, ButtonToolbar, Well } from "../antd-bootstrap";
-import { ErrorDisplay, Icon, A } from "../components";
+import { Button, ButtonToolbar, Well } from "@cocalc/frontend/antd-bootstrap";
+import {
+  Component,
+  React,
+  Rendered,
+  rtypes,
+} from "@cocalc/frontend/app-framework";
+import { A, ErrorDisplay, Icon } from "@cocalc/frontend/components";
 
 interface Props {
   initial_click: () => void;
diff --git a/src/packages/frontend/account/keyboard-settings.tsx b/src/packages/frontend/account/keyboard-settings.tsx
@@ -3,12 +3,17 @@
  *  License: AGPLv3 s.t. "Commons Clause" – see LICENSE.md for details
  */
 
-import { useTypedRedux } from "../app-framework";
-import { Icon, LabeledRow, Loading, SelectorInput } from "../components";
-import { Panel } from "../antd-bootstrap";
-import { set_account_table } from "./util";
-import { IS_MACOS } from "../feature";
+import { Panel } from "@cocalc/frontend/antd-bootstrap";
+import { useTypedRedux } from "@cocalc/frontend/app-framework";
+import {
+  Icon,
+  LabeledRow,
+  Loading,
+  SelectorInput,
+} from "@cocalc/frontend/components";
+import { IS_MACOS } from "@cocalc/frontend/feature";
 import keyboardShortcuts from "./keyboard-shortcuts";
+import { set_account_table } from "./util";
 
 const KEYBOARD_SHORTCUTS = keyboardShortcuts(IS_MACOS);
 
@@ -29,7 +34,7 @@ export const KeyboardSettings: React.FC = () => {
       v.push(
         <LabeledRow key={desc} label={desc} label_cols={LABEL_COLS}>
           {shortcut}
-        </LabeledRow>
+        </LabeledRow>,
       );
     }
     return v;
diff --git a/src/packages/frontend/account/profile-image.tsx b/src/packages/frontend/account/profile-image.tsx
@@ -4,14 +4,24 @@
  */
 
 import { Map as ImmutableMap } from "immutable";
-import { Button, ButtonToolbar, FormControl, Well } from "../antd-bootstrap";
-import { Component, Rendered } from "../app-framework";
-import { ErrorDisplay, Loading, ProfileIcon } from "../components";
 import Pica from "pica";
-import gravatarUrl from "./gravatar-url";
-import { webapp_client } from "@cocalc/frontend/webapp-client";
 import ReactCropComponent from "react-image-crop";
 import "react-image-crop/dist/ReactCrop.css";
+import gravatarUrl from "./gravatar-url";
+
+import {
+  Button,
+  ButtonToolbar,
+  FormControl,
+  Well,
+} from "@cocalc/frontend/antd-bootstrap";
+import { Component, Rendered } from "@cocalc/frontend/app-framework";
+import {
+  ErrorDisplay,
+  Loading,
+  ProfileIcon,
+} from "@cocalc/frontend/components";
+import { webapp_client } from "@cocalc/frontend/webapp-client";
 
 // This is what facebook uses, and it makes
 // 40x40 look very good.  It takes about 20KB
diff --git a/src/packages/frontend/account/profile-settings.tsx b/src/packages/frontend/account/profile-settings.tsx
@@ -4,12 +4,18 @@
  */
 
 import { Map } from "immutable";
-import { rclass, rtypes, Component, Rendered } from "../app-framework";
-import { Panel } from "../antd-bootstrap";
-import { LabeledRow, Loading, Gap } from "../components";
-import { ColorPicker } from "../colorpicker";
-import { ProfileImageSelector, setProfile } from "./profile-image";
+
+import { Panel } from "@cocalc/frontend/antd-bootstrap";
+import {
+  Component,
+  Rendered,
+  rclass,
+  rtypes,
+} from "@cocalc/frontend/app-framework";
+import { ColorPicker } from "@cocalc/frontend/colorpicker";
+import { Gap, LabeledRow, Loading } from "@cocalc/frontend/components";
 import { Avatar } from "./avatar/avatar";
+import { ProfileImageSelector, setProfile } from "./profile-image";
 
 interface Props {
   email_address?: string;
diff --git a/src/packages/frontend/account/sign-out.tsx b/src/packages/frontend/account/sign-out.tsx
@@ -2,10 +2,10 @@
  *  This file is part of CoCalc: Copyright © 2020 Sagemath, Inc.
  *  License: AGPLv3 s.t. "Commons Clause" – see LICENSE.md for details
  */
-
-import { React, Rendered, redux } from "../app-framework";
 import { Button, Popconfirm } from "antd";
+
 import { LogoutOutlined } from "@ant-design/icons";
+import { React, Rendered, redux } from "@cocalc/frontend/app-framework";
 import track from "@cocalc/frontend/user-tracking";
 
 interface Props {
diff --git a/src/packages/frontend/account/util.ts b/src/packages/frontend/account/util.ts
@@ -3,8 +3,8 @@
  *  License: AGPLv3 s.t. "Commons Clause" – see LICENSE.md for details
  */
 
-import { redux } from "../app-framework";
-import { alert_message } from "../alerts";
+import { alert_message } from "@cocalc/frontend/alerts";
+import { redux } from "@cocalc/frontend/app-framework";
 
 export function set_account_table(obj: object): void {
   redux.getTable("account").set(obj);
diff --git a/src/packages/frontend/components/link-retry.tsx b/src/packages/frontend/components/link-retry.tsx
@@ -3,14 +3,14 @@
  *  License: AGPLv3 s.t. "Commons Clause" – see LICENSE.md for details
  */
 
-import { Button } from "antd";
+import { Button, Tooltip } from "antd";
 
 import {
   useEffect,
   useIsMountedRef,
   useState,
 } from "@cocalc/frontend/app-framework";
-import { Icon, Loading, Gap } from "@cocalc/frontend/components";
+import { Gap, Icon, Loading } from "@cocalc/frontend/components";
 import { open_new_tab } from "@cocalc/frontend/misc";
 import { retry_until_success } from "@cocalc/util/async-utils";
 import { COLORS } from "@cocalc/util/theme";
@@ -24,6 +24,7 @@ interface Props {
   onClick?: () => void;
   autoStart?: boolean;
   maxTime?: number;
+  tooltip?: string;
 }
 
 const LinkRetry: React.FC<Props> = ({
@@ -35,6 +36,7 @@ const LinkRetry: React.FC<Props> = ({
   autoStart,
   maxTime = 30000,
   loadingText,
+  tooltip,
 }: Props) => {
   const isMountedRef = useIsMountedRef();
   const [working, setWorking] = useState<boolean>(false);
@@ -104,42 +106,44 @@ const LinkRetry: React.FC<Props> = ({
     }
   }, []);
 
+  function renderError() {
+    if (!error) return;
+    return (
+      <span style={{ color: COLORS.ANTD_RED_WARN }}>
+        <Gap /> (failed to load)
+      </span>
+    );
+  }
+
   switch (mode) {
     case "link":
+      const aLink = (
+        <a onClick={click} style={{ cursor: "pointer" }}>
+          {children}
+        </a>
+      );
+      const a = tooltip ? <Tooltip title={tooltip}>{aLink}</Tooltip> : aLink;
       return (
         <span>
-          <a onClick={click} style={{ cursor: "pointer" }}>
-            {children}
-          </a>
+          {a}
           {mode === "link" && loading && (
             <span>
               <Gap /> <Loading text={loadingText} />
             </span>
           )}
-          {error && (
-            <>
-              <span style={{ color: COLORS.ANTD_RED_WARN }}>
-                <Gap /> (failed to load)
-              </span>
-            </>
-          )}
+          {renderError()}
         </span>
       );
     case "button":
-      return (
+      const btn = (
         <Button onClick={click} size={size}>
           {children}
-          {loading ? (
-            <Icon name="cocalc-ring" spin />
-          ) : (
-            error && (
-              <span style={{ color: COLORS.ANTD_RED_WARN }}>
-                (failed to load)
-              </span>
-            )
-          )}
+          {loading ? <Icon name="cocalc-ring" spin /> : renderError()}
         </Button>
       );
+      if (tooltip) {
+        return <Tooltip title={tooltip}>{btn}</Tooltip>;
+      }
     default:
       throw Error("invalid mode");
   }
diff --git a/src/packages/frontend/course/configuration/customize-student-project-functionality.tsx b/src/packages/frontend/course/configuration/customize-student-project-functionality.tsx
@@ -16,6 +16,7 @@ import {
 } from "@cocalc/frontend/app-framework";
 import { Icon, Tip } from "@cocalc/frontend/components";
 import type { StudentProjectFunctionality } from "@cocalc/util/db-schema/projects";
+import { R_IDE } from "@cocalc/util/consts/ui";
 export type { StudentProjectFunctionality };
 
 interface Option {
@@ -71,9 +72,8 @@ const OPTIONS: Option[] = [
   },
   {
     name: "disableRServer",
-    title: "RStudio Server",
-    description:
-      "Disable the user interface for running an RStudio server in student projects.  RStudio is an IDE for R.",
+    title: R_IDE,
+    description: `Disable the user interface for running the ${R_IDE} server in student projects.  This is an IDE for coding in R.`,
   },
   {
     name: "disableTerminals",
diff --git a/src/packages/frontend/frame-editors/jupyter-editor/markdown-notebook.tsx b/src/packages/frontend/frame-editors/jupyter-editor/markdown-notebook.tsx
@@ -8,7 +8,7 @@ Frame for working with a Jupyter notebook as a single markdown
 document, like in RStudio or our RMarkdown editor.
 */
 
-import { Rendered, Component } from "../../app-framework";
+import { Rendered, Component } from "@cocalc/frontend/app-framework";
 
 interface Props {
   project_id: string;
diff --git a/src/packages/frontend/project/named-server-panel.tsx b/src/packages/frontend/project/named-server-panel.tsx
@@ -21,6 +21,7 @@ import LinkRetry from "@cocalc/frontend/components/link-retry";
 import { useStudentProjectFunctionality } from "@cocalc/frontend/course";
 import { appBasePath } from "@cocalc/frontend/customize/app-base-path";
 import track from "@cocalc/frontend/user-tracking";
+import { R_IDE } from "@cocalc/util/consts/ui";
 import { capitalize } from "@cocalc/util/misc";
 import { COLORS } from "@cocalc/util/theme";
 import { NamedServerName } from "@cocalc/util/types/servers";
@@ -71,8 +72,8 @@ code completion, snippets, code refactoring, and embedded Git.`,
     icon: "julia",
   },
   rserver: {
-    longName: "RStudio",
-    description: `RStudio by Posit Software, PBC is an integrated development environment (IDE) for R. It is provided without any modifications.  DISCLAIMER: RSTUDIO/POSIT PBC IS IN NO WAY ASSOCIATED WITH COCALC.`,
+    longName: R_IDE,
+    description: `This is an integrated development environment (IDE) for R. It is provided without any modifications. DISCLAIMER: Posit Software, PBC (formerly RStudio, PBC) IS IN NO WAY ASSOCIATED WITH COCALC.`,
     usesBasePath: false,
     icon: "r",
   },
@@ -185,14 +186,15 @@ export function serverURL(project_id: string, name: NamedServerName): string {
 export function ServerLink({
   project_id,
   name,
+  mode = "full",
 }: {
   project_id: string;
   name: NamedServerName;
+  mode: "flyout" | "full";
 }) {
   const student_project_functionality =
     useStudentProjectFunctionality(project_id);
   const available = useAvailableFeatures(project_id);
-  const { icon, longName } = getServerInfo(name);
   if (
     name === "jupyterlab" &&
     (!available.jupyter_lab ||
@@ -221,10 +223,12 @@ export function ServerLink({
   ) {
     return null;
   } else {
+    const { icon, longName, description } = getServerInfo(name);
     return (
       <LinkRetry
         href={serverURL(project_id, name)}
         loadingText="Launching server..."
+        tooltip={mode === "flyout" ? description : undefined}
         onClick={() => {
           track("launch-server", { name, project_id });
         }}
diff --git a/src/packages/frontend/project/page/flyouts/servers.tsx b/src/packages/frontend/project/page/flyouts/servers.tsx
@@ -19,7 +19,7 @@ import { FLYOUT_PADDING } from "./consts";
 
 export function ServersFlyout({ project_id, wrap }) {
   const servers = NAMED_SERVER_NAMES.map((name) => (
-    <ServerLink key={name} name={name} project_id={project_id} />
+    <ServerLink key={name} name={name} project_id={project_id} mode={"flyout"} />
   )).filter((s) => s != null);
 
   function renderEmbeddedServers() {
diff --git a/src/packages/frontend/project/servers/project-servers.tsx b/src/packages/frontend/project/servers/project-servers.tsx
@@ -14,6 +14,7 @@ import {
   computeServersEnabled,
 } from "@cocalc/frontend/compute";
 import { HelpEmailLink } from "@cocalc/frontend/customize";
+import { R_IDE } from "@cocalc/util/consts/ui";
 import { NamedServerName } from "@cocalc/util/types/servers";
 import { NamedServerPanel } from "../named-server-panel";
 import { NewFileButton } from "../new/new-file-button";
@@ -99,7 +100,7 @@ export function ProjectServers(props: Props) {
           {available.rserver ? (
             <Col sm={sm} md={md}>
               <NewFileButton
-                name={"RStudio..."}
+                name={`${R_IDE}...`}
                 icon={"r"}
                 active={showNamedServer === "rserver"}
                 on_click={() => toggleShowNamedServer("rserver")}
diff --git a/src/packages/frontend/project/settings/project-capabilites.tsx b/src/packages/frontend/project/settings/project-capabilites.tsx
@@ -12,6 +12,7 @@ import { Rendered, redux, useTypedRedux } from "@cocalc/frontend/app-framework";
 import { A, Icon, Loading, SettingBox } from "@cocalc/frontend/components";
 import { CUSTOM_SOFTWARE_HELP_URL } from "@cocalc/frontend/custom-software/util";
 import { tool2display } from "@cocalc/util/code-formatter";
+import { R_IDE } from "@cocalc/util/consts/ui";
 import * as misc from "@cocalc/util/misc";
 import { COLORS } from "@cocalc/util/theme";
 import { Project } from "./types";
@@ -53,7 +54,7 @@ export const ProjectCapabilities: React.FC<ReactProps> = React.memo(
         ["pandoc", "File format conversions via pandoc"],
         ["vscode", "VSCode editor"],
         ["julia", "Julia programming language"],
-        ["rserver", "RStudio Server"],
+        ["rserver", R_IDE],
       ];
       const features: JSX.Element[] = [];
       let any_nonavail = false;
diff --git a/src/packages/next/pages/features/x11.tsx b/src/packages/next/pages/features/x11.tsx
@@ -5,6 +5,7 @@
 
 import { Col, Layout, Row } from "antd";
 
+import { R_IDE } from "@cocalc/util/consts/ui";
 import Code from "components/landing/code";
 import Content from "components/landing/content";
 import Footer from "components/landing/footer";
@@ -117,7 +118,7 @@ export default function X11({ customize }) {
                   include <A href="http://maxima.sourceforge.net/">Maxima</A>,{" "}
                   <A href="https://www.libreoffice.org/">LibreOffice</A>,{" "}
                   <A href="https://www.openmodelica.org/">OpenModelica</A>,{" "}
-                  <A href="https://www.rstudio.com/">RStudio</A>,{" "}
+                  <A href="https://www.rstudio.com/">{R_IDE}</A>,{" "}
                   <A href="https://swirlstats.com/">
                     {"{"}swirl{"}"}
                   </A>
diff --git a/src/packages/util/consts/ui.ts b/src/packages/util/consts/ui.ts
@@ -20,5 +20,7 @@ export const SHARE_FLAGS = {
 } as const;
 
 // documentation pages
-
 export const DOC_AI = "https://doc.cocalc.com/ai.html";
+
+// How we call Posit's RStudio (rserver) IDE
+export const R_IDE = "R IDE";
