Skip to content

Refactored docs on feature flag consumption in code. #571

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

trmartin4
Copy link
Member

@trmartin4 trmartin4 commented Apr 2, 2025

📔 Objective

The documentation on consumption of feature flags on clients was out of date. It described specific methods that needed to be used, and had been made obsolete by a refactor of the ConfigService on web clients as well as the move to native mobile apps.

Rather than describe code in the docs, I've removed that section and instead focused on describing how clients need to react to client caching of flag values, as well as how developers can override it locally. This was not documented previously.

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation
    team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed
    issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

Copy link

cloudflare-workers-and-pages bot commented Apr 2, 2025

Deploying contributing-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: a2809f7
Status: ✅  Deploy successful!
Preview URL: https://0819c028.contributing-docs.pages.dev
Branch Preview URL: https://feature-flag-cache-override.contributing-docs.pages.dev

View logs

Copy link

github-actions bot commented Apr 2, 2025

Logo
Checkmarx One – Scan Summary & Details54774efe-1aaa-4d2d-917e-238f719d0c89

Great job, no security vulnerabilities found in this Pull Request

@trmartin4
Copy link
Member Author

@vvolkgang do we have any documentation on how feature flags are cached on the mobile apps? I've added a section here that describes how this works on the TS clients, and I want to make sure I address mobile as well if there is any comparable logic.

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.

1 participant