gws_core

Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version

FAQ

This documentation is an FAQ / Troubleshoot for the dev environment and Codelab. 


Error during the start of the dev environment


The error during the start of the development environment can have various causes. It's important to check the console for any error messages to better understand the issue.


ModuleNotFoundError: No module named 'fastapi'


This error indicates that the fastapi module was not installed properly. Often, this means that none of the gws_core dependency modules were installed. The error appears with the fastapi module because it is the first module to be loaded.


To diagnose why the packages were not installed during the start of the codelab, follow these steps:


  1. Open your Space.
    1. Open your Data Lab detail page.
      1. Click on the Configuration tab.
        1. In the lab manager, expand the Lab manager advanced config section.
          1. Search for Codelab and click on the 🔍 View logs button on the right.
            1. (Optional) In the menu button, you can choose to view only the errors to narrow down the logs.
              1. Look for any error messages during the installation of the bricks. Most of the time, a failure in brick installation causes the failure of package installation.

              By following the steps above, you should be able to pinpoint the cause of the failure and take corrective actions.


              Error during migration of brick


              If you encounter the error 'Error during migration of brick '[BRICK_NAME]' from version 'X' to version 'Y', it may be because the system is attempting to migrate from an outdated version. Since the migration is triggered in the development environment and only runs when the dev environment starts, the lab might have been updated many times since the last dev environment update.


              How to fix the issue?


              You need to force the system to run the migrations one by one. There are two scenarios:


              Scenario 1: The dev environment is not starting


              This usually happens if the issue occurs with a gws_core brick.


              1. Close the corresponding brick in the /lab/user/bricks folder.
                1. Use Git to switch the code to the next version of the last migration.
                  1. For example, if the error is 'from version 0.9.0' to version '0.10.0', switch the code to version 0.10.0. This will make the system try to update from 0.9.0 to 0.10.0 only.
                  2. To find the version in the code, check the Git tags.

                    Scenario 2: The dev environment is starting


                    1. Open your Data Lab in dev mode.
                      1. Open ⚙️ Settings > Monitoring.
                        1. In the dashboard, go to Bricks and find the corresponding brick, then expand it.
                          1. Click on 🛠️ Call migration manually and execute the migrations one by one.

                            By following these steps, you should be able to address the error during the migration of the brick effectively.