Enhance Dashboard App: Workspace & Profile Integration

Hey everyone! Let's dive into a cool project that's all about sprucing up our dashboard app. We're talking about making it smarter by integrating workspace information and a profile selector. This update is especially important because we're leveling up how we manage profiles using the ProfilesRunContext base class. So, buckle up; we're about to make some changes that will make things smoother and more user-friendly. We'll be touching on some key elements like workspace display, profile selection, and end-to-end testing to ensure everything works seamlessly. It's going to be a fun ride, so let's get started!

Background: The Power of ProfilesRunContext

So, we've introduced a shiny new tool called ProfilesRunContext. It's the backbone for managing profiles in a unified way. Think of it as the brain that keeps track of all the different profiles you might be using. This is super helpful, especially if you're juggling multiple projects or need to switch between different configurations. The goal here is to make the dashboard app aware of ProfilesRunContext so it can display the workspace and profile name. We want the dashboard to be smart enough to recognize when it's running with a specific profile and show you exactly what's going on. This kind of context awareness is a game-changer for productivity, making it easier to keep track of your current settings and configurations. Plus, it helps avoid any confusion about which profile is active. This is a great initiative to make the system more transparent and user-friendly. This is great news for the team and its users!

Key Benefits and Why It Matters

• Simplified Profile Management: Imagine easily switching between profiles without a hitch! This is what we're aiming for, simplifying the user experience by providing a streamlined method for managing your profiles.
• Enhanced User Experience: We're aiming to make your experience more intuitive and less confusing. By displaying the workspace and profile name directly in the dashboard, you'll always know exactly what's running.
• Improved Efficiency: No more guessing games or accidental misconfigurations. With clear profile identification, you can save time and avoid potential errors, which ultimately boosts your overall productivity.
• Transparent Configuration: Users will always be aware of the current settings, offering a transparent understanding of their active profile and workspace.

Requirements: What We Need to Achieve

Alright, let's break down what we need to do. We've got a few key requirements that will drive the changes. The goal here is to create a dashboard app that's both informative and easy to use.

1. Workspace and Profile Display: If ProfilesRunContext is detected, the dashboard should proudly display the workspace and profile name at the top. This is like a helpful little label that tells you exactly where you are and what settings are active. It's all about making sure you have the right context at a glance.
2. Profile Selector: We need a way to change profiles directly from the dashboard. Think of it as a dropdown menu or a selector that lets you pick a different profile with a simple click. This should have a select action to switch the profile. This makes profile switching a breeze.
3. End-to-End Testing: We're not just building; we're making sure it works perfectly. This means we'll need comprehensive end-to-end tests to ensure everything runs smoothly. This is where we simulate real-world scenarios to catch any issues before they cause trouble. This is super important to make sure that the app works perfectly.

Detailed Breakdown of Each Requirement

• Display Workspace and Profile:
  • When ProfilesRunContext is present, the application will show the workspace and profile information at the top of the dashboard. This offers users clear visibility into their current context.
  • This allows users to instantly recognize the active environment.
• Implement Profile Selector:
  • Develop a profile selector with an option to switch profiles. This functionality should allow users to choose between different profiles.
  • The profile selector should allow seamless switching.
• End-to-End Testing:
  • We'll conduct thorough testing to validate all functions, including profile selection, workspace display, and other associated features.
  • The goal is to create a reliable and stable application. This will help in ensuring the stability and correctness of the system, giving us the confidence to release it.

Implementation: The Road to Success

Here's how we're going to bring this to life. Before we get started with the core features, we need to do some housekeeping. We'll be moving the dashboard app to the _workspace module and shifting its tests to tests/workspace. This will help to organize the project structure. This move will help maintain the code in a cleaner, and more manageable manner.

Moving and Organizing the Code

We'll be restructuring the dashboard app to the _workspace module, and the tests associated with the dashboard app will be moved to the tests/workspace directory. This code organization streamlines the project structure. It ensures better code management.

Using the ProfilesRunContext

Here's a quick snippet to show you how ProfilesRunContext is used. This will give you an idea of what's going on behind the scenes:

def display_run_context_info() -> None:
    run_context = dlt.current.run_context()
    if isinstance(run_context, ProfilesRunContext):
        if run_context.default_profile != run_context.profile:
            # print warning
            fmt.echo(