hale-commenting-system 3.6.0 → 3.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hale-commenting-system",
-  "version": "3.6.0",
+  "version": "3.7.0",
   "description": "A commenting system for PatternFly React applications that allows designers and developers to add comments directly on design pages, sync with GitHub Issues, and link Jira tickets.",
   "homepage": "https://www.npmjs.com/package/hale-commenting-system",
   "license": "MIT",

package/src/app/commenting-system/components/JiraTab.tsx

@@ -47,8 +47,17 @@ interface LegacyJiraRecord {
 
 type JiraStore = Record<string, JiraRecord>;
 
+// Jira Issue Cache
+type CachedJiraIssue = {
+  ticket: JiraTicket;
+  fetchedAt: number; // timestamp
+};
+type JiraIssueCache = Record<string, CachedJiraIssue>;
+
 const STORAGE_KEY = 'hale_commenting_jira_v1';
+const CACHE_STORAGE_KEY = 'hale_commenting_jira_cache_v1';
 const GH_JIRA_PATH = '.hale/jira.json';
+const CACHE_TTL_MS = 15 * 60 * 1000; // 15 minutes
 
 function migrateRecord(record: LegacyJiraRecord): JiraRecord {
   // If it's already in the new format, return as-is
@@ -100,6 +109,50 @@ function setStore(next: JiraStore) {
   window.localStorage.setItem(STORAGE_KEY, JSON.stringify(next));
 }
 
+function getIssueCache(): JiraIssueCache {
+  if (typeof window === 'undefined') return {};
+  try {
+    const raw = window.localStorage.getItem(CACHE_STORAGE_KEY);
+    if (!raw) return {};
+    return JSON.parse(raw) as JiraIssueCache;
+  } catch {
+    return {};
+  }
+}
+
+function setIssueCache(cache: JiraIssueCache) {
+  if (typeof window === 'undefined') return;
+  window.localStorage.setItem(CACHE_STORAGE_KEY, JSON.stringify(cache));
+}
+
+function getCachedIssue(key: string): JiraTicket | null {
+  const cache = getIssueCache();
+  const cached = cache[key];
+  if (!cached) return null;
+
+  const now = Date.now();
+  const age = now - cached.fetchedAt;
+
+  // Return cached data if it's still fresh
+  if (age < CACHE_TTL_MS) {
+    return cached.ticket;
+  }
+
+  // Expired - remove it
+  delete cache[key];
+  setIssueCache(cache);
+  return null;
+}
+
+function setCachedIssue(key: string, ticket: JiraTicket) {
+  const cache = getIssueCache();
+  cache[key] = {
+    ticket,
+    fetchedAt: Date.now(),
+  };
+  setIssueCache(cache);
+}
+
 function normalizePathname(pathname: string): string {
   if (!pathname) return '/';
   const cleaned = pathname.split('?')[0].split('#')[0];
@@ -339,7 +392,7 @@ export const JiraTab: React.FunctionComponent = () => {
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, []);
 
-  // Fetch Jira issue details for all keys.
+  // Fetch Jira issue details for all keys (with caching).
   React.useEffect(() => {
     const keys = record?.jiraKeys || [];
     if (keys.length === 0) {
@@ -354,24 +407,50 @@ export const JiraTab: React.FunctionComponent = () => {
       const results: Record<string, JiraTicket> = {};
       const errors: Record<string, string> = {};
 
-      await Promise.all(
-        keys.map(async (key) => {
-          try {
-            const resp = await fetch(`/api/jira-issue?key=${encodeURIComponent(key)}`);
-            const payload = await resp.json().catch(() => ({}));
-            if (!resp.ok) {
-              const raw = String(payload?.message || `Failed to fetch Jira issue (${resp.status})`);
-              const sanitized = raw.trim().startsWith('<') ? 'Unauthorized or non-JSON response from Jira.' : raw;
-              const hint = payload?.hint ? ` ${String(payload.hint)}` : '';
-              errors[key] = `${sanitized}${hint}`;
-              return;
+      // Check cache first
+      const keysToFetch: string[] = [];
+      for (const key of keys) {
+        const cached = getCachedIssue(key);
+        if (cached) {
+          results[key] = cached;
+        } else {
+          keysToFetch.push(key);
+        }
+      }
+
+      // Fetch uncached issues
+      if (keysToFetch.length > 0) {
+        await Promise.all(
+          keysToFetch.map(async (key) => {
+            try {
+              const resp = await fetch(`/api/jira-issue?key=${encodeURIComponent(key)}`);
+              const payload = await resp.json().catch(() => ({}));
+
+              if (!resp.ok) {
+                // Handle rate limiting specially
+                if (resp.status === 429) {
+                  errors[key] = 'Rate limit exceeded. Please wait a few minutes and refresh the page.';
+                  return;
+                }
+
+                const raw = String(payload?.message || `Failed to fetch Jira issue (${resp.status})`);
+                const sanitized = raw.trim().startsWith('<') ? 'Unauthorized or non-JSON response from Jira.' : raw;
+                const hint = payload?.hint ? ` ${String(payload.hint)}` : '';
+                errors[key] = `${sanitized}${hint}`;
+                return;
+              }
+
+              const ticket = payload as JiraTicket;
+              results[key] = ticket;
+
+              // Cache the successful result
+              setCachedIssue(key, ticket);
+            } catch (e: any) {
+              errors[key] = e?.message || 'Failed to fetch Jira issue';
             }
-            results[key] = payload as JiraTicket;
-          } catch (e: any) {
-            errors[key] = e?.message || 'Failed to fetch Jira issue';
-          }
-        })
-      );
+          })
+        );
+      }
 
       setIssues(results);
       setIssueErrors(errors);
@@ -735,7 +814,14 @@ export const JiraTab: React.FunctionComponent = () => {
 
                   {/* Error state */}
                   {error && !isFetchingIssues && (
-                    <div style={{ fontSize: '0.875rem', color: 'var(--pf-t--global--danger--color--100)' }}>{error}</div>
+                    <div style={{ display: 'grid', gap: '0.5rem' }}>
+                      <div style={{ fontSize: '0.875rem', color: 'var(--pf-t--global--danger--color--100)' }}>{error}</div>
+                      {error.includes('Rate limit') && (
+                        <div style={{ fontSize: '0.75rem', color: 'var(--pf-t--global--text--color--subtle)' }}>
+                          Tip: Jira data is cached for 15 minutes to reduce API calls. Refreshing the page will retry.
+                        </div>
+                      )}
+                    </div>
                   )}
 
                   {/* Issue details */}