Class ProjectListSerializer

api/projects/serializers.py:21–71

class ProjectListSerializer(serializers.ModelSerializer):  # type: ignore[type-arg]
    migration_status = serializers.SerializerMethodField(
        help_text="Edge migration status of the project; can be one of: "
        + ", ".join([k.value for k in ProjectIdentityMigrationStatus])
    )
    use_edge_identities = serializers.SerializerMethodField()

    class Meta:
        model = Project
        fields = (
            "id",
            "uuid",
            "name",
            "organisation",
            "hide_disabled_flags",
            "enable_dynamo_db",
            "migration_status",
            "use_edge_identities",
            "prevent_flag_defaults",
            "enable_realtime_updates",
            "only_allow_lower_case_feature_names",
            "feature_name_regex",
            "show_edge_identity_overrides_for_feature",
            "stale_flags_limit_days",
            "edge_v2_migration_status",
            "minimum_change_request_approvals",
            "enforce_feature_owners",
        )
        read_only_fields = (
            "enable_dynamo_db",
            "edge_v2_migration_status",
        )

    def get_migration_status(self, obj: Project) -> str:
        if not settings.PROJECT_METADATA_TABLE_NAME_DYNAMO:
            migration_status = ProjectIdentityMigrationStatus.NOT_APPLICABLE.value
        elif obj.is_edge_project_by_default:
            migration_status = ProjectIdentityMigrationStatus.MIGRATION_COMPLETED.value
        else:
            migration_status = IdentityMigrator(obj.id).migration_status.value  # type: ignore[no-untyped-call]

        # Add migration status to the context - to be used by `get_use_edge_identities`
        self.context["migration_status"] = migration_status

        return migration_status

    def get_use_edge_identities(self, obj: Project) -> bool:
        return (  # type: ignore[no-any-return]
            self.context["migration_status"]
            == ProjectIdentityMigrationStatus.MIGRATION_COMPLETED.value
        )


class ProjectCreateSerializer(ReadOnlyIfNotValidPlanMixin, ProjectListSerializer):