fix: breaking changes mechanism (HEXA-1469) (#340)

Author: yolanfery

openhexa/cli/api.py

@@ -150,12 +150,19 @@ def _detect_graphql_breaking_changes(token):
         )
         for change in breaking_changes:
             click.secho(f"- {change.description}", fg="yellow")
-        click.secho(
-            "This could lead to unexpected results.\n"
-            f"Please update the SDK to the latest version {latest_version} "
-            f"(using `pip install openhexa-sdk=={latest_version}`) or use a version of the SDK compatible with the server.",
-            fg="red",
-        )
+        click.secho("This could lead to unexpected results.", fg="red")
+        if current_version == latest_version:
+            click.secho(
+                "The SDK has schema changes not yet supported by the server. "
+                "To ensure compatibility with the server, it might be required to use a older version of the SDK.",
+                fg="red",
+            )
+        else:
+            click.secho(
+                f"Please update the SDK to the latest version {latest_version} "
+                f"(using `pip install openhexa-sdk=={latest_version}`) to ensure compatibility.",
+                fg="red",
+            )
 
 
 def graphql(query: str, variables=None, token=None):

openhexa/cli/cli.py

@@ -79,7 +79,7 @@ def app(ctx):
     if settings.last_version_check is None or now_timestamp - settings.last_version_check > ONE_HOUR:
         installed_version, latest_version = get_library_versions()
         settings.last_version_check = now_timestamp
-        if installed_version != latest_version or True:
+        if installed_version != latest_version:
             click.secho(
                 "\n".join(
                     (

openhexa/graphql/graphql_client/__init__.py

@@ -89,6 +89,7 @@
     AccessmodProjectOrder,
     AddOrganizationMemberError,
     AddToFavoritesError,
+    AddWebappToShortcutsError,
     ApproveAccessmodAccessRequestError,
     ArchiveWorkspaceError,
     BucketObjectType,
@@ -105,6 +106,7 @@
     CreateDatasetVersionError,
     CreateDatasetVersionFileError,
     CreateMembershipError,
+    CreateOrganizationError,
     CreatePipelineFromTemplateVersionError,
     CreatePipelineTemplateVersionError,
     CreateTeamError,
@@ -126,6 +128,7 @@
     DeleteDatasetVersionError,
     DeleteMembershipError,
     DeleteMetadataAttributeError,
+    DeleteOrganizationError,
     DeleteOrganizationInvitationError,
     DeleteOrganizationMemberError,
     DeletePipelineVersionError,
@@ -152,6 +155,7 @@
     IASOMetadataType,
     InviteOrganizationMemberError,
     InviteWorkspaceMembershipError,
+    IssueWorkspaceTokenError,
     JoinWorkspaceError,
     LaunchAccessmodAnalysisError,
     LaunchNotebookServerError,
@@ -174,12 +178,14 @@
     PipelineRunStatus,
     PipelineRunTrigger,
     PipelineTemplateError,
+    PipelineTemplateOrderBy,
     PipelineType,
     PrepareObjectDownloadError,
     PrepareObjectUploadError,
     PrepareVersionFileDownloadError,
     RegisterError,
     RemoveFromFavoritesError,
+    RemoveWebappFromShortcutsError,
     RequestAccessmodAccessError,
     ResendOrganizationInvitationError,
     ResendWorkspaceInvitationError,
@@ -197,7 +203,9 @@
     UpdateDatasetError,
     UpdateDatasetVersionError,
     UpdateMembershipError,
+    UpdateOrganizationError,
     UpdateOrganizationMemberError,
+    UpdateOrganizationSubscriptionError,
     UpdatePipelineError,
     UpdatePipelineVersionError,
     UpdateTeamError,
@@ -209,6 +217,7 @@
     UpdateWorkspaceMemberError,
     UpgradePipelineVersionFromTemplateError,
     VerifyDeviceError,
+    WebappType,
     WorkspaceInvitationStatus,
     WorkspaceMembershipRole,
 )
@@ -237,6 +246,7 @@
     AddOrganizationMemberInput,
     AddPipelineOutputInput,
     AddToFavoritesInput,
+    AddWebappToShortcutsInput,
     ApproveAccessmodAccessRequestInput,
     ArchiveWorkspaceInput,
     ConnectionFieldInput,
@@ -253,6 +263,7 @@
     CreateDatasetVersionFileInput,
     CreateDatasetVersionInput,
     CreateMembershipInput,
+    CreateOrganizationInput,
     CreatePipelineFromTemplateVersionInput,
     CreatePipelineInput,
     CreatePipelineRecipientInput,
@@ -272,6 +283,7 @@
     DeleteDatasetVersionInput,
     DeleteMembershipInput,
     DeleteMetadataAttributeInput,
+    DeleteOrganizationInput,
     DeleteOrganizationInvitationInput,
     DeleteOrganizationMemberInput,
     DeletePipelineInput,
@@ -295,6 +307,7 @@
     IASOQueryFilterInput,
     InviteOrganizationMemberInput,
     InviteWorkspaceMemberInput,
+    IssueWorkspaceTokenInput,
     JoinWorkspaceInput,
     LaunchAccessmodAnalysisInput,
     LaunchNotebookServerInput,
@@ -314,10 +327,12 @@
     PrepareVersionFileDownloadInput,
     RegisterInput,
     RemoveFromFavoritesInput,
+    RemoveWebappFromShortcutsInput,
     RequestAccessmodAccessInput,
     ResendOrganizationInvitationInput,
     ResendWorkspaceInvitationInput,
     ResetPasswordInput,
+    ResourceCountsInput,
     RunDAGInput,
     RunPipelineInput,
     SetDAGRunFavoriteInput,
@@ -334,7 +349,9 @@
     UpdateDatasetInput,
     UpdateDatasetVersionInput,
     UpdateMembershipInput,
+    UpdateOrganizationInput,
     UpdateOrganizationMemberInput,
+    UpdateOrganizationSubscriptionInput,
     UpdatePipelineInput,
     UpdatePipelineProgressInput,
     UpdatePipelineRecipientInput,
@@ -443,6 +460,8 @@
     "AddToFavoritesInput",
     "AddWebappToFavorites",
     "AddWebappToFavoritesAddToFavorites",
+    "AddWebappToShortcutsError",
+    "AddWebappToShortcutsInput",
     "ApproveAccessmodAccessRequestError",
     "ApproveAccessmodAccessRequestInput",
     "ArchiveWorkspace",
@@ -486,6 +505,8 @@
     "CreateDatasetVersionInput",
     "CreateMembershipError",
     "CreateMembershipInput",
+    "CreateOrganizationError",
+    "CreateOrganizationInput",
     "CreatePipeline",
     "CreatePipelineCreatePipeline",
     "CreatePipelineCreatePipelinePipeline",
@@ -562,6 +583,8 @@
     "DeleteMembershipInput",
     "DeleteMetadataAttributeError",
     "DeleteMetadataAttributeInput",
+    "DeleteOrganizationError",
+    "DeleteOrganizationInput",
     "DeleteOrganizationInvitationError",
     "DeleteOrganizationInvitationInput",
     "DeleteOrganizationMemberError",
@@ -637,6 +660,8 @@
     "InviteWorkspaceMemberInviteWorkspaceMember",
     "InviteWorkspaceMemberInviteWorkspaceMemberWorkspaceMembership",
     "InviteWorkspaceMembershipError",
+    "IssueWorkspaceTokenError",
+    "IssueWorkspaceTokenInput",
     "JoinWorkspaceError",
     "JoinWorkspaceInput",
     "LaunchAccessmodAnalysisError",
@@ -680,6 +705,7 @@
     "PipelineRunStatus",
     "PipelineRunTrigger",
     "PipelineTemplateError",
+    "PipelineTemplateOrderBy",
     "PipelineTokenInput",
     "PipelineType",
     "Pipelines",
@@ -704,13 +730,16 @@
     "RemoveFromFavoritesInput",
     "RemoveWebappFromFavorites",
     "RemoveWebappFromFavoritesRemoveFromFavorites",
+    "RemoveWebappFromShortcutsError",
+    "RemoveWebappFromShortcutsInput",
     "RequestAccessmodAccessError",
     "RequestAccessmodAccessInput",
     "ResendOrganizationInvitationError",
     "ResendOrganizationInvitationInput",
     "ResendWorkspaceInvitationError",
     "ResendWorkspaceInvitationInput",
     "ResetPasswordInput",
+    "ResourceCountsInput",
     "RunDAGError",
     "RunDAGInput",
     "RunPipelineInput",
@@ -750,8 +779,12 @@
     "UpdateDatasetVersionInput",
     "UpdateMembershipError",
     "UpdateMembershipInput",
+    "UpdateOrganizationError",
+    "UpdateOrganizationInput",
     "UpdateOrganizationMemberError",
     "UpdateOrganizationMemberInput",
+    "UpdateOrganizationSubscriptionError",
+    "UpdateOrganizationSubscriptionInput",
     "UpdatePipelineError",
     "UpdatePipelineHeartbeat",
     "UpdatePipelineHeartbeatUpdatePipelineHeartbeat",
@@ -790,6 +823,7 @@
     "UploadPipelineUploadPipeline",
     "VerifyDeviceError",
     "VerifyDeviceInput",
+    "WebappType",
     "Workspace",
     "WorkspaceInvitationInput",
     "WorkspaceInvitationStatus",

openhexa/graphql/graphql_client/enums.py

@@ -82,6 +82,11 @@ class AddToFavoritesError(str, Enum):
     WEBAPP_NOT_FOUND = "WEBAPP_NOT_FOUND"
 
 
+class AddWebappToShortcutsError(str, Enum):
+    ITEM_ALREADY_EXISTS = "ITEM_ALREADY_EXISTS"
+    ITEM_NOT_FOUND = "ITEM_NOT_FOUND"
+
+
 class ApproveAccessmodAccessRequestError(str, Enum):
     INVALID = "INVALID"
 
@@ -171,6 +176,12 @@ class CreateMembershipError(str, Enum):
     PERMISSION_DENIED = "PERMISSION_DENIED"
 
 
+class CreateOrganizationError(str, Enum):
+    INVALID_EMAIL = "INVALID_EMAIL"
+    NAME_DUPLICATE = "NAME_DUPLICATE"
+    PERMISSION_DENIED = "PERMISSION_DENIED"
+
+
 class CreatePipelineFromTemplateVersionError(str, Enum):
     PERMISSION_DENIED = "PERMISSION_DENIED"
     PIPELINE_TEMPLATE_VERSION_NOT_FOUND = "PIPELINE_TEMPLATE_VERSION_NOT_FOUND"
@@ -208,6 +219,7 @@ class CreateWorkspaceError(str, Enum):
     INVALID_SLUG = "INVALID_SLUG"
     ORGANIZATION_NOT_FOUND = "ORGANIZATION_NOT_FOUND"
     PERMISSION_DENIED = "PERMISSION_DENIED"
+    WORKSPACES_LIMIT_REACHED = "WORKSPACES_LIMIT_REACHED"
 
 
 class DAGRunOrderBy(str, Enum):
@@ -313,6 +325,11 @@ class DeleteMetadataAttributeError(str, Enum):
     TARGET_NOT_FOUND = "TARGET_NOT_FOUND"
 
 
+class DeleteOrganizationError(str, Enum):
+    NOT_FOUND = "NOT_FOUND"
+    PERMISSION_DENIED = "PERMISSION_DENIED"
+
+
 class DeleteOrganizationInvitationError(str, Enum):
     INVITATION_NOT_FOUND = "INVITATION_NOT_FOUND"
     PERMISSION_DENIED = "PERMISSION_DENIED"
@@ -427,6 +444,7 @@ class InviteOrganizationMemberError(str, Enum):
     ALREADY_MEMBER = "ALREADY_MEMBER"
     ORGANIZATION_NOT_FOUND = "ORGANIZATION_NOT_FOUND"
     PERMISSION_DENIED = "PERMISSION_DENIED"
+    USERS_LIMIT_REACHED = "USERS_LIMIT_REACHED"
     WORKSPACE_NOT_FOUND = "WORKSPACE_NOT_FOUND"
 
 
@@ -437,6 +455,16 @@ class InviteWorkspaceMembershipError(str, Enum):
     WORKSPACE_NOT_FOUND = "WORKSPACE_NOT_FOUND"
 
 
+class IssueWorkspaceTokenError(str, Enum):
+    AUTH_UNAUTHENTICATED = "AUTH_UNAUTHENTICATED"
+    CLOCK_ERROR = "CLOCK_ERROR"
+    CONFIG_MISSING_PRIVATE_KEY = "CONFIG_MISSING_PRIVATE_KEY"
+    INPUT_INVALID = "INPUT_INVALID"
+    MEMBERSHIP_REQUIRED = "MEMBERSHIP_REQUIRED"
+    ROLE_UNRESOLVED = "ROLE_UNRESOLVED"
+    WORKSPACE_NOT_FOUND = "WORKSPACE_NOT_FOUND"
+
+
 class JoinWorkspaceError(str, Enum):
     ALREADY_ACCEPTED = "ALREADY_ACCEPTED"
     ALREADY_EXISTS = "ALREADY_EXISTS"
@@ -549,6 +577,7 @@ class PipelineError(str, Enum):
     PIPELINE_CODE_PARSING_ERROR = "PIPELINE_CODE_PARSING_ERROR"
     PIPELINE_DOES_NOT_SUPPORT_PARAMETERS = "PIPELINE_DOES_NOT_SUPPORT_PARAMETERS"
     PIPELINE_NOT_FOUND = "PIPELINE_NOT_FOUND"
+    PIPELINE_RUNS_LIMIT_REACHED = "PIPELINE_RUNS_LIMIT_REACHED"
     PIPELINE_VERSION_NOT_FOUND = "PIPELINE_VERSION_NOT_FOUND"
     TABLE_NOT_FOUND = "TABLE_NOT_FOUND"
     WORKSPACE_NOT_FOUND = "WORKSPACE_NOT_FOUND"
@@ -583,6 +612,7 @@ class PipelineRunStatus(str, Enum):
     failed = "failed"
     queued = "queued"
     running = "running"
+    skipped = "skipped"
     stopped = "stopped"
     success = "success"
     terminating = "terminating"
@@ -599,6 +629,15 @@ class PipelineTemplateError(str, Enum):
     PIPELINE_TEMPLATE_NOT_FOUND = "PIPELINE_TEMPLATE_NOT_FOUND"
 
 
+class PipelineTemplateOrderBy(str, Enum):
+    CREATED_AT_ASC = "CREATED_AT_ASC"
+    CREATED_AT_DESC = "CREATED_AT_DESC"
+    NAME_ASC = "NAME_ASC"
+    NAME_DESC = "NAME_DESC"
+    PIPELINES_COUNT_ASC = "PIPELINES_COUNT_ASC"
+    PIPELINES_COUNT_DESC = "PIPELINES_COUNT_DESC"
+
+
 class PipelineType(str, Enum):
     notebook = "notebook"
     zipFile = "zipFile"
@@ -631,6 +670,10 @@ class RemoveFromFavoritesError(str, Enum):
     WEBAPP_NOT_FOUND = "WEBAPP_NOT_FOUND"
 
 
+class RemoveWebappFromShortcutsError(str, Enum):
+    ITEM_NOT_FOUND = "ITEM_NOT_FOUND"
+
+
 class RequestAccessmodAccessError(str, Enum):
     ALREADY_EXISTS = "ALREADY_EXISTS"
     INVALID = "INVALID"
@@ -725,12 +768,26 @@ class UpdateMembershipError(str, Enum):
     PERMISSION_DENIED = "PERMISSION_DENIED"
 
 
+class UpdateOrganizationError(str, Enum):
+    INVALID_LOGO = "INVALID_LOGO"
+    INVALID_SHORT_NAME = "INVALID_SHORT_NAME"
+    NAME_DUPLICATE = "NAME_DUPLICATE"
+    NOT_FOUND = "NOT_FOUND"
+    PERMISSION_DENIED = "PERMISSION_DENIED"
+    SHORT_NAME_DUPLICATE = "SHORT_NAME_DUPLICATE"
+
+
 class UpdateOrganizationMemberError(str, Enum):
     INVALID_ROLE = "INVALID_ROLE"
     NOT_FOUND = "NOT_FOUND"
     PERMISSION_DENIED = "PERMISSION_DENIED"
 
 
+class UpdateOrganizationSubscriptionError(str, Enum):
+    NOT_FOUND = "NOT_FOUND"
+    PERMISSION_DENIED = "PERMISSION_DENIED"
+
+
 class UpdatePipelineError(str, Enum):
     INVALID_CONFIG = "INVALID_CONFIG"
     MISSING_VERSION_CONFIG = "MISSING_VERSION_CONFIG"
@@ -791,6 +848,13 @@ class VerifyDeviceError(str, Enum):
     NO_DEVICE = "NO_DEVICE"
 
 
+class WebappType(str, Enum):
+    BUNDLE = "BUNDLE"
+    HTML = "HTML"
+    IFRAME = "IFRAME"
+    SUPERSET = "SUPERSET"
+
+
 class WorkspaceInvitationStatus(str, Enum):
     ACCEPTED = "ACCEPTED"
     DECLINED = "DECLINED"