Refactor feed creation UX flow

Author: gildesmarais

app/api/v1/root_metadata.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require 'uri'
-
-require_relative '../../account_manager'
+require_relative '../../auto_source'
 
 module Html2rss
   module Web
@@ -21,57 +19,22 @@ def build(router)
                   description: 'RESTful API for converting websites to RSS feeds',
                   openapi_url: "#{router.base_url}/api/v1/openapi.yaml"
                 },
-                demo: demo_payload
+                instance: instance_payload(router)
               }
             end
 
             private
 
+            # @param _router [Roda::RodaRequest]
             # @return [Hash{Symbol=>Object}]
-            def demo_payload
-              account = AccountManager.get_account_by_username('demo')
-              return { enabled: false, sources: [] } unless account
-
+            def instance_payload(_router)
               {
-                enabled: true,
-                token: account[:token],
-                strategy: 'ssrf_filter',
-                sources: Array(account[:allowed_urls]).map.with_index do |url, index|
-                  { id: demo_source_id(url, index), url: url }
-                end
+                feed_creation: {
+                  enabled: AutoSource.enabled?,
+                  access_token_required: AutoSource.enabled?
+                }
               }
             end
-
-            # @param url [String]
-            # @param index [Integer]
-            # @return [String]
-            def demo_source_id(url, index)
-              parts = demo_source_parts(url)
-              return parts.join('-').gsub(/[^a-zA-Z0-9]+/, '-').downcase if parts.any?
-
-              fallback_demo_source_id(index)
-            rescue URI::InvalidURIError
-              fallback_demo_source_id(index)
-            end
-
-            # @param url [String]
-            # @return [Array<String>]
-            def demo_source_parts(url)
-              uri = URI.parse(url)
-              [uri.host.to_s.gsub(/^www\./, ''), first_path_segment(uri)].reject(&:empty?)
-            end
-
-            # @param uri [URI::Generic]
-            # @return [String]
-            def first_path_segment(uri)
-              uri.path.to_s.split('/').find { |segment| !segment.empty? }.to_s
-            end
-
-            # @param index [Integer]
-            # @return [String]
-            def fallback_demo_source_id(index)
-              "demo-#{index + 1}"
-            end
           end
         end
       end

docs/api/v1/openapi.yaml

@@ -41,41 +41,32 @@ paths:
                         - description
                         - openapi_url
                         type: object
-                      demo:
+                      instance:
                         properties:
-                          enabled:
-                            type: boolean
-                          sources:
-                            items:
-                              properties:
-                                id:
-                                  type: string
-                                url:
-                                  type: string
-                              required:
-                              - id
-                              - url
-                              type: object
-                            type: array
-                          strategy:
-                            type: string
-                          token:
-                            type: string
+                          feed_creation:
+                            properties:
+                              access_token_required:
+                                type: boolean
+                              enabled:
+                                type: boolean
+                            required:
+                            - enabled
+                            - access_token_required
+                            type: object
                         required:
-                        - enabled
-                        - sources
+                        - feed_creation
                         type: object
                     required:
                     - api
-                    - demo
+                    - instance
                     type: object
                   success:
                     type: boolean
                 required:
                 - success
                 - data
                 type: object
-          description: returns OpenAPI document URL in metadata
+          description: returns instance feed-creation capability
       security: []
       summary: API metadata
       tags:

frontend/package-lock.json

@@ -1,16 +1,15 @@
 import { describe, it, expect } from 'vitest';
 import { render, screen, fireEvent, waitFor } from '@testing-library/preact';
+import { within } from '@testing-library/preact';
 import { http, HttpResponse } from 'msw';
 import { server, buildFeedResponse } from './mocks/server';
 import { App } from '../components/App';
 
 describe('App contract', () => {
-  const username = 'contract-user';
   const token = 'contract-token';
 
   const authenticate = () => {
-    window.sessionStorage.setItem('html2rss_username', username);
-    window.sessionStorage.setItem('html2rss_token', token);
+    window.sessionStorage.setItem('html2rss_access_token', token);
   };
 
   it('shows feed result when API responds with success', async () => {
@@ -40,19 +39,22 @@ describe('App contract', () => {
 
     render(<App />);
 
-    await screen.findByText(username);
+    await screen.findByText('Generate a feed from a web page');
 
-    const urlInput = screen.getByLabelText('URL') as HTMLInputElement;
+    const urlInput = screen.getByLabelText('Source URL') as HTMLInputElement;
     fireEvent.input(urlInput, { target: { value: 'https://example.com/articles' } });
 
-    fireEvent.click(screen.getByRole('button', { name: 'Convert' }));
+    fireEvent.click(screen.getByRole('button', { name: 'Generate feed URL' }));
 
     await waitFor(() => {
-      expect(screen.getByText('Feed created')).toBeInTheDocument();
+      const resultRegion = document.getElementById('feed-result');
+      expect(resultRegion).not.toBeNull();
+      const resultQueries = within(resultRegion!);
+
+      expect(screen.getByText('Feed ready')).toBeInTheDocument();
       expect(screen.getByText('Example Feed')).toBeInTheDocument();
-      expect(screen.getByRole('button', { name: 'Copy URL' })).toBeInTheDocument();
-      expect(screen.getByRole('link', { name: 'Subscribe in reader' })).toBeInTheDocument();
-      expect(screen.getByText('Opens your default RSS reader if configured.')).toBeInTheDocument();
+      expect(resultQueries.getByRole('button', { name: 'Copy feed URL' })).toBeInTheDocument();
+      expect(resultQueries.getByRole('link', { name: 'Open feed' })).toBeInTheDocument();
     });
   });
 });