feat(notices): notices lib, refactor, use for "yahooSurvey" (#783)

src/index-common.ts

@@ -3,7 +3,7 @@ import yahooFinanceFetch from "./lib/yahooFinanceFetch.js";
 import options from "./lib/options.js";
 import errors from "./lib/errors.js";
 import setGlobalConfig from "./lib/setGlobalConfig.js";
-import moduleExec from "./lib/moduleExec.js";
+import { suppressNotices } from "./lib/notices.js";
 
 // modules
 import autoc from "./modules/autoc.js";
@@ -33,6 +33,7 @@ export default {
   // common
   errors,
   setGlobalConfig,
+  suppressNotices,
 
   // modules,
   autoc,

src/lib/getCrumb.ts

@@ -3,6 +3,7 @@ import type { ExtendedCookieJar } from "./cookieJar";
 import pkg from "../../package.json";
 import { Logger } from "./options.js";
 import { Cookie } from "tough-cookie";
+import { showNotice } from "./notices.js";
 
 const CONFIG_FAKE_URL = "http://config.yf2/";
 
@@ -342,8 +343,6 @@ export async function getCrumbClear(cookieJar: ExtendedCookieJar) {
   await cookieJar.removeAllCookies();
 }
 
-let shownYahooSurvey = false;
-
 export default function getCrumb(
   cookieJar: ExtendedCookieJar,
   fetch: (url: RequestInfo, init?: RequestInit) => Promise<Response>,
@@ -352,14 +351,7 @@ export default function getCrumb(
   url = "https://finance.yahoo.com/quote/AAPL",
   __getCrumb = _getCrumb
 ) {
-  if (!shownYahooSurvey) {
-    logger.info(
-      "Please consider completing the survey at https://bit.ly/yahoo-finance-api-feedback " +
-        "if you haven't already; for more info see " +
-        "https://github.com/gadicc/node-yahoo-finance2/issues/764#issuecomment-2056623851."
-    );
-    shownYahooSurvey = true;
-  }
+  showNotice("yahooSurvey");
 
   if (!promise)
     promise = __getCrumb(cookieJar, fetch, fetchOptionsBase, logger, url);

src/lib/notices.ts

@@ -0,0 +1,46 @@
+import options from "./options.js";
+const logger = options.logger || console;
+
+type Notice = {
+  id: string;
+  text: string;
+  level?: keyof typeof logger;
+  onceOnly?: boolean;
+  suppress?: boolean;
+};
+
+const notices = {
+  yahooSurvey: {
+    id: "yahooSurvey",
+    text:
+      "Please consider completing the survey at https://bit.ly/yahoo-finance-api-feedback " +
+      "if you haven't already; for more info see " +
+      "https://github.com/gadicc/node-yahoo-finance2/issues/764#issuecomment-2056623851.",
+    onceOnly: true,
+  } as Notice,
+};
+
+export function showNotice(id: keyof typeof notices) {
+  const n = notices[id];
+  if (!n) throw new Error(`Unknown notice id: ${id}`);
+
+  if (n.suppress) return;
+  if (n.onceOnly) n.suppress = true;
+
+  const text =
+    n.text +
+    // (n.onceOnly ? " (only shown once)" : "") +
+    "  You can supress this message in future with `yahooFinance.supressNotices(['" +
+    id +
+    "'])`.";
+  const level = n.level || "info";
+  logger[level](text);
+}
+
+export function suppressNotices(noticeIds: (keyof typeof notices)[]) {
+  noticeIds.forEach((id) => {
+    const n = notices[id];
+    if (!n) logger.error(`Unknown notice id: ${id}`);
+    n.suppress = true;
+  });
+}

tests/setupTests.js

@@ -1,3 +1,6 @@
+import { suppressNotices } from "../src/lib/notices";
+suppressNotices(["yahooSurvey"]);
+
 import { toBeType } from "jest-tobetype";
 
 expect.extend({