Merge pull request #3181 from github/nora/adjust-log-messages

Remove ambiguity from 'View logs' messages
github · Jan 3, 2024 · 8daf337 · 8daf337
2 parents b27d8a1 + cfbc443
commit 8daf337
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 10 deletions.
diff --git a/extensions/ql-vscode/src/common/logging/vscode/output-channel-logger.ts b/extensions/ql-vscode/src/common/logging/vscode/output-channel-logger.ts
@@ -63,7 +63,7 @@ export class OutputChannelLogger
     message: string,
     show: (message: string, ...items: string[]) => Thenable<string | undefined>,
   ): Promise<void> {
-    const label = "Show Log";
+    const label = "View extension logs";
     const result = await show(message, label);
 
     if (result === label) {

diff --git a/extensions/ql-vscode/src/stories/common/Alert.stories.tsx b/extensions/ql-vscode/src/stories/common/Alert.stories.tsx
@@ -70,8 +70,8 @@ ErrorExample.args = {
     <>
       Request to
       https://api.github.com/repos/octodemo/Hello-World/code-scanning/codeql/queries
-      failed. <VSCodeLink>Check logs</VSCodeLink> and try running this query
-      again.
+      failed. <VSCodeLink>View actions logs</VSCodeLink> and try running this
+      query again.
     </>
   ),
 };
@@ -84,7 +84,7 @@ ErrorWithButtons.args = {
     "Request to https://api.github.com/repos/octodemo/Hello-World/code-scanning/codeql/queries failed. Try running this query again.",
   actions: (
     <>
-      <VSCodeButton appearance="secondary">View logs</VSCodeButton>
+      <VSCodeButton appearance="secondary">View actions logs</VSCodeButton>
       <VSCodeButton>Retry</VSCodeButton>
     </>
   ),

diff --git a/extensions/ql-vscode/src/view/variant-analysis/FailureReasonAlert.tsx b/extensions/ql-vscode/src/view/variant-analysis/FailureReasonAlert.tsx
@@ -33,8 +33,8 @@ const getMessage = (failureReason: VariantAnalysisFailureReason): ReactNode => {
       return (
         <>
           The GitHub Actions workflow run has failed.{" "}
-          <VSCodeLink onClick={openLogs}>Check logs</VSCodeLink> and try running
-          this query again.
+          <VSCodeLink onClick={openLogs}>View actions logs</VSCodeLink> and try
+          running this query again.
         </>
       );
     case VariantAnalysisFailureReason.InternalError:

diff --git a/extensions/ql-vscode/src/view/variant-analysis/VariantAnalysisStatusStats.tsx b/extensions/ql-vscode/src/view/variant-analysis/VariantAnalysisStatusStats.tsx
@@ -36,7 +36,7 @@ export const VariantAnalysisStatusStats = ({
         <span>{completedAt !== undefined ? formatDate(completedAt) : "-"}</span>
       )}
       {onViewLogsClick && (
-        <VSCodeLink onClick={onViewLogsClick}>View logs</VSCodeLink>
+        <VSCodeLink onClick={onViewLogsClick}>View actions logs</VSCodeLink>
       )}
     </Container>
   );

diff --git a/extensions/ql-vscode/src/view/variant-analysis/__tests__/VariantAnalysisStats.spec.tsx b/extensions/ql-vscode/src/view/variant-analysis/__tests__/VariantAnalysisStats.spec.tsx
@@ -146,7 +146,7 @@ describe(VariantAnalysisStats.name, () => {
       completedAt: new Date(),
     });
 
-    await userEvent.click(screen.getByText("View logs"));
+    await userEvent.click(screen.getByText("View actions logs"));
     expect(onViewLogsClick).toHaveBeenCalledTimes(1);
   });
 

diff --git a/extensions/ql-vscode/src/view/variant-analysis/__tests__/VariantAnalysisStatusStats.spec.tsx b/extensions/ql-vscode/src/view/variant-analysis/__tests__/VariantAnalysisStatusStats.spec.tsx
@@ -53,7 +53,7 @@ describe(VariantAnalysisStatusStats.name, () => {
       onViewLogsClick: () => undefined,
     });
 
-    expect(screen.getByText("View logs")).toBeInTheDocument();
+    expect(screen.getByText("View actions logs")).toBeInTheDocument();
   });
 
   it("renders when there isn't a viewLogs links", () => {
@@ -62,6 +62,6 @@ describe(VariantAnalysisStatusStats.name, () => {
       onViewLogsClick: undefined,
     });
 
-    expect(screen.queryByText("View logs")).not.toBeInTheDocument();
+    expect(screen.queryByText("View actions logs")).not.toBeInTheDocument();
   });
 });