Fetch notifications as part of the list command and run that in background

Author: gonzaloriestra

packages/cli-kit/assets/fetch-notifications.js

@@ -3,14 +3,14 @@ import {reportAnalyticsEvent} from '../analytics.js'
 import {outputDebug} from '../../../public/node/output.js'
 import BaseCommand from '../base-command.js'
 import * as metadata from '../../../public/node/metadata.js'
-import {exec} from '../system.js'
+import {fetchNotificationsInBackground} from '../notifications-system.js'
 import {Command, Hook} from '@oclif/core'
 
 // This hook is called after each successful command run. More info: https://oclif.io/docs/hooks
 export const hook: Hook.Postrun = async ({config, Command}) => {
   await detectStopCommand(Command as unknown as typeof Command)
   await reportAnalyticsEvent({config, exitMode: 'ok'})
-  await exec('node', [require.resolve('@shopify/cli-kit/assets/fetch-notifications.js')], {background: true})
+  fetchNotificationsInBackground()
   deprecationsHook(Command)
 
   const command = Command.id.replace(/:/g, ' ')

packages/cli-kit/src/public/node/hooks/postrun.ts

@@ -6,18 +6,15 @@ import {zod} from './schema.js'
 import {AbortSilentError} from './error.js'
 import {isTruthy} from './context/utilities.js'
 import {jsonOutputEnabled} from './environment.js'
+import {exec} from './system.js'
 import {CLI_KIT_VERSION} from '../common/version.js'
 import {NotificationKey, NotificationsKey, cacheRetrieve, cacheStore} from '../../private/node/conf-store.js'
+import {fetch} from '@shopify/cli-kit/node/http'
 
 const URL = 'https://cdn.shopify.com/static/cli/notifications.json'
 const EMPTY_CACHE_MESSAGE = 'Cache is empty'
 
-/**
- * Returns the URL to retrieve the notifications.
- *
- * @returns - The value from SHOPIFY_CLI_NOTIFICATIONS_URL or the default URL (https://cdn.shopify.com/static/cli/notifications.json).
- */
-export function notificationsUrl(): string {
+function url(): string {
   return process.env.SHOPIFY_CLI_NOTIFICATIONS_URL ?? URL
 }
 
@@ -112,18 +109,55 @@ async function renderNotifications(notifications: Notification[]) {
 }
 
 /**
- * Get notifications list from cache, that is updated in the background from the fetch-notifications.json script.
+ * Get notifications list from cache, that is updated in the background from bin/fetch-notifications.json.
  *
  * @returns A Notifications object.
  */
 export async function getNotifications(): Promise<Notifications> {
-  const cacheKey: NotificationsKey = `notifications-${notificationsUrl()}`
+  const cacheKey: NotificationsKey = `notifications-${url()}`
   const rawNotifications = cacheRetrieve(cacheKey)?.value as unknown as string
   if (!rawNotifications) throw new Error(EMPTY_CACHE_MESSAGE)
   const notifications: object = JSON.parse(rawNotifications)
   return NotificationsSchema.parse(notifications)
 }
 
+/**
+ * Fetch notifications from the CDN and chache them.
+ *
+ * @returns A string with the notifications.
+ */
+export async function fetchNotifications(): Promise<Notifications> {
+  outputDebug(`Fetching  notifications...`)
+  const response = await fetch(url(), {signal: AbortSignal.timeout(3 * 1000)})
+  if (response.status !== 200) throw new Error(`Failed to fetch notifications: ${response.statusText}`)
+  const rawNotifications = await response.text()
+  await cacheNotifications(rawNotifications)
+  const notifications: object = JSON.parse(rawNotifications)
+  return NotificationsSchema.parse(notifications)
+}
+
+/**
+ * Store the notifications in the cache.
+ *
+ * @param notifications - String with the notifications to cache.
+ * @returns A Notifications object.
+ */
+async function cacheNotifications(notifications: string): Promise<void> {
+  cacheStore(`notifications-${url()}`, notifications)
+  outputDebug(`Notifications from ${url()} stored in the cache`)
+}
+
+/**
+ * Fetch notifications in background as a detached process.
+ */
+export function fetchNotificationsInBackground(): void {
+  // eslint-disable-next-line no-void
+  void exec('shopify', ['notifications', 'list'], {
+    background: true,
+    env: {...process.env, SHOPIFY_CLI_NO_ANALYTICS: '1'},
+  })
+}
+
 /**
  * Filters notifications based on the version of the CLI.
  *

packages/cli-kit/src/public/node/notifications-system.ts

@@ -6,6 +6,7 @@ import {
   Notification,
   stringifyFilters,
   getNotifications,
+  fetchNotifications,
 } from '@shopify/cli-kit/node/notifications-system'
 import {outputInfo} from '@shopify/cli-kit/node/output'
 import {renderSelectPrompt, renderTextPrompt, renderSuccess, renderTable, TableColumn} from '@shopify/cli-kit/node/ui'
@@ -95,7 +96,7 @@ export async function generate() {
 }
 
 export async function list() {
-  const notifications: Notifications = await getNotifications()
+  const notifications = await fetchNotifications()
 
   const columns: TableColumn<{type: string; title: string; message: string; filters: string}> = {
     type: {header: 'Type', color: 'dim'},
@@ -107,7 +108,7 @@ export async function list() {
   const rows = notifications.notifications.map((notification: Notification) => {
     return {
       type: notification.type,
-      title: notification.title || '',
+      title: notification.title ?? '',
       message: notification.message,
       filters: stringifyFilters(notification),
     }