Skip to content

Conversation

Aathish101
Copy link

@Aathish101 Aathish101 commented Oct 9, 2025

Feature Preview


PR Checklist

  • My code adheres to AppFlowy's Conventions
  • I've listed at least one issue that this PR fixes in the description above.
  • I've added a test(s) to validate changes in this PR, or this PR only contains semantic changes.
  • All existing tests are passing.

Summary by Sourcery

Revamp the web entrypoint index.html to apply AppFlowy branding, streamline meta tags, and enhance the user experience with a CSS-based loading spinner that is hidden once the main Flutter script loads.

Enhancements:

  • Update base href, meta tags (description, viewport, Apple PWA settings), title, and icons for AppFlowy branding
  • Add a centered CSS spinner (#loading-indicator) with keyframe animation to display during initial load
  • Introduce hideLoadingIndicator function and integrate it into loadMainDartJs to remove the spinner once the app starts loading
  • Remove default Flutter comments and consolidate head section for a cleaner template

Copy link
Contributor

sourcery-ai bot commented Oct 9, 2025

Reviewer's Guide

This PR refactors index.html to streamline PWA metadata, update branding, add a loading spinner, and tweak the service worker bootstrap logic to hide the spinner once the app loads.

File-Level Changes

Change Details Files
Revise HTML head metadata and branding
  • Removed placeholder comments around base href
  • Updated meta tags: description, viewport, charset, IE compatibility
  • Refreshed Apple PWA tags and touch icon
  • Changed document title to “AppFlowy: The Open-Source Workspace”
frontend/appflowy_flutter/web/index.html
Introduce a CSS-driven loading spinner
  • Added <style> block defining #loading-indicator and spinner keyframes
  • Inserted
    into the body
frontend/appflowy_flutter/web/index.html
Enhance service worker bootstrap to hide spinner
  • Added hideLoadingIndicator() to remove spinner before app load
  • Updated loadMainDartJs() to call hideLoadingIndicator()
  • Condensed comments and preserved existing registration logic
frontend/appflowy_flutter/web/index.html

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@Aathish101
Copy link
Author

updated html

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey there - I've reviewed your changes - here's some feedback:

  • Reintroduce a timeout fallback to load main.dart.js in case service worker registration stalls, so the loading spinner doesn’t persist indefinitely.
  • Extract the inline spinner CSS into a separate stylesheet or component to keep styles modular and themeable.
  • Include a comment or script to dynamically set when deploying under a subpath, since that configuration was removed.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Reintroduce a timeout fallback to load main.dart.js in case service worker registration stalls, so the loading spinner doesn’t persist indefinitely.
- Extract the inline spinner CSS into a separate stylesheet or component to keep styles modular and themeable.
- Include a comment or script to dynamically set <base href> when deploying under a subpath, since that configuration was removed.

## Individual Comments

### Comment 1
<location> `frontend/appflowy_flutter/web/index.html:56` </location>
<code_context>
+    
+    function loadMainDartJs() {
+      // NEW: Hide indicator before starting the main Dart script load
+      hideLoadingIndicator(); 
+      
+      if (scriptLoaded) {
</code_context>

<issue_to_address>
**suggestion (bug_risk):** The loading indicator is hidden before the main Dart script is loaded, which may cause a brief flash of uninitialized UI.

Hide the loading indicator after the Dart script has loaded and the app is initialized to prevent users from seeing incomplete UI.

Suggested implementation:

```
    function loadMainDartJs() {
      // Hide indicator AFTER the main Dart script has loaded and app is initialized
      if (scriptLoaded) {
        return;
      }
      scriptLoaded = true;
      var scriptTag = document.createElement('script');
      scriptTag.src = 'main.dart.js';
      scriptTag.type = 'application/javascript';
      scriptTag.addEventListener('load', function() {
        // Optionally, you may want to wait for Dart app initialization here
        hideLoadingIndicator();
      });
      document.body.append(scriptTag);
    }

```

If your Dart app exposes a global callback or event for when initialization is complete (e.g., `window.flutterAppInitialized`), you should call `hideLoadingIndicator()` in that callback instead of the script's `load` event. Adjust as needed for your app's initialization flow.
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.


    function loadMainDartJs() {
      // NEW: Hide indicator before starting the main Dart script load
      hideLoadingIndicator();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (bug_risk): The loading indicator is hidden before the main Dart script is loaded, which may cause a brief flash of uninitialized UI.

Hide the loading indicator after the Dart script has loaded and the app is initialized to prevent users from seeing incomplete UI.

Suggested implementation:

    function loadMainDartJs() {
      // Hide indicator AFTER the main Dart script has loaded and app is initialized
      if (scriptLoaded) {
        return;
      }
      scriptLoaded = true;
      var scriptTag = document.createElement('script');
      scriptTag.src = 'main.dart.js';
      scriptTag.type = 'application/javascript';
      scriptTag.addEventListener('load', function() {
        // Optionally, you may want to wait for Dart app initialization here
        hideLoadingIndicator();
      });
      document.body.append(scriptTag);
    }

If your Dart app exposes a global callback or event for when initialization is complete (e.g., window.flutterAppInitialized), you should call hideLoadingIndicator() in that callback instead of the script's load event. Adjust as needed for your app's initialization flow.

@Aathish101
Copy link
Author

updated

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants