feat(api): Add CanCreateModelIngestion model permission check (#436)

* CanCreateModelIngestion check

* assert this way

* correct exception type

.github/workflows/integration-test.yml

@@ -51,7 +51,7 @@ jobs:
 
       - name: 🔨 Integration Tests against Internal Server
         if: ${{ inputs.use-internal-image }}
-        run: dotnet test ${{ env.Solution }} --filter "Category=Integration" --configuration Release --no-build --no-restore --verbosity=normal /p:AltCover=true /p:AltCoverAttributeFilter=ExcludeFromCodeCoverage
+        run: dotnet test ${{ env.Solution }} --filter "(Category=Integration)&(Server!=Public)" --configuration Release --no-build --no-restore --verbosity=normal /p:AltCover=true /p:AltCoverAttributeFilter=ExcludeFromCodeCoverage
 
       - name: Upload coverage reports to Codecov with GitHub Action
         uses: codecov/codecov-action@v5

src/Speckle.Sdk/Api/GraphQL/Resources/ModelIngestionResource.cs

@@ -6,7 +6,7 @@ using Speckle.Sdk.Api.GraphQL.Models.Responses;
 namespace Speckle.Sdk.Api.GraphQL.Resources;
 
 /// <remarks>
-/// Model Ingestion API is available for server versions <c>3.0.3-alpha.583</c> and above
+/// Model Ingestion API is available for server versions <c>3.0.3</c> and above
 /// </remarks>
 public sealed class ModelIngestionResource
 {
@@ -23,7 +23,7 @@ public sealed class ModelIngestionResource
   /// <remarks>
   /// The model ingestion created will have a <c>processing</c> state (not <c>queued</c>). This mutation is designed to be used
   /// by client/connectors that are immediately processing
-  /// Model Ingestion API is available for server versions <c>3.0.3-alpha.583</c> and above
+  /// Model Ingestion API is available for server versions <c>3.0.3</c> and above
   /// </remarks>
   /// <param name="input"></param>
   /// <param name="cancellationToken"></param>
@@ -72,7 +72,7 @@ public sealed class ModelIngestionResource
   }
 
   /// <remarks>
-  /// Model Ingestion API is available for server versions <c>3.0.3-alpha.583</c> and above
+  /// Model Ingestion API is available for server versions <c>3.0.3</c> and above
   /// </remarks>
   /// <param name="modelIngestionId"></param>
   /// <param name="projectId"></param>
@@ -121,7 +121,7 @@ public sealed class ModelIngestionResource
   /// For File Import / Cloud integrations only
   /// </summary>
   /// <remarks>
-  /// Model Ingestion API is available for server versions <c>3.0.3-alpha.583</c> and above
+  /// Model Ingestion API is available for server versions <c>3.0.3</c> and above
   /// </remarks>
   /// <param name="input"></param>
   /// <param name="cancellationToken"></param>
@@ -173,7 +173,7 @@ public sealed class ModelIngestionResource
   /// For File Import / Cloud integrations only
   /// </summary>
   /// <remarks>
-  /// Model Ingestion API is available for server versions <c>3.0.3-alpha.583</c> and above
+  /// Model Ingestion API is available for server versions <c>3.0.3</c> and above
   /// </remarks>
   /// <param name="input"></param>
   /// <param name="cancellationToken"></param>
@@ -222,7 +222,7 @@ public sealed class ModelIngestionResource
   }
 
   /// <remarks>
-  /// Model Ingestion API is available for server versions <c>3.0.3-alpha.583</c> and above
+  /// Model Ingestion API is available for server versions <c>3.0.3</c> and above
   /// </remarks>
   /// <param name="input"></param>
   /// <param name="cancellationToken"></param>
@@ -277,7 +277,7 @@ public sealed class ModelIngestionResource
   /// If successful, the job will be in a terminal "successful" state.
   /// </summary>
   /// <remarks>
-  /// Model Ingestion API is available for server versions <c>3.0.3-alpha.583</c> and above
+  /// Model Ingestion API is available for server versions <c>3.0.3</c> and above
   /// </remarks>
   /// <seealso cref="FailWithError"/>
   /// <seealso cref="FailWithCancel"/>
@@ -320,7 +320,7 @@ public sealed class ModelIngestionResource
   /// </summary>
   /// <remarks>
   /// For requested user cancellation, use <see cref="FailWithCancel"/> instead<br/>
-  /// Model Ingestion API is available for server versions <c>3.0.3-alpha.583</c> and above
+  /// Model Ingestion API is available for server versions <c>3.0.3</c> and above
   /// </remarks>
   /// <seealso cref="FailWithCancel"/>
   /// <seealso cref="Complete"/>
@@ -375,7 +375,7 @@ public sealed class ModelIngestionResource
   /// This should only be done if the user has explicitly requested cancellation
   /// Other forms of cancellation use <see cref="FailWithError"/>.
   /// The ingestion should then enter a terminal "canceled" state.<br/>
-  /// Model Ingestion API is available for server versions <c>3.0.3-alpha.583</c> and above
+  /// Model Ingestion API is available for server versions <c>3.0.3</c> and above
   /// </summary>
   /// <seealso cref="FailWithError"/>
   /// <seealso cref="Complete"/>
@@ -434,7 +434,7 @@ public sealed class ModelIngestionResource
   /// via <see cref="SubscriptionResource.CreateProjectModelIngestionCancellationRequestedSubscription"/>
   /// and report it as canceled via  <see cref="ModelIngestionResource.FailWithCancel"/>
   /// See "cooperative cancellation pattern"<br/>
-  /// Model Ingestion API is available for server versions <c>3.0.3-alpha.583</c> and above
+  /// Model Ingestion API is available for server versions <c>3.0.3</c> and above
   /// </remarks>
   /// <seealso cref="FailWithError"/>
   /// <seealso cref="Complete"/>

src/Speckle.Sdk/Api/GraphQL/Resources/ModelResource.cs

@@ -359,4 +359,41 @@ public sealed class ModelResource
       .ConfigureAwait(false);
     return response.data.data.data;
   }
+
+  /// <param name="projectId"></param>
+  /// <param name="cancellationToken"></param>
+  /// <returns></returns>
+  /// <exception cref="SpeckleGraphQLBadInputException">server versions &lt;3.0.11 do not have <c>canCreateIngestion</c> and will throw this exception</exception>
+  /// <inheritdoc cref="ISpeckleGraphQLClient.ExecuteGraphQLRequest{T}"/>
+  public async Task<PermissionCheckResult> CanCreateModelIngestion(
+    string projectId,
+    string modelId,
+    CancellationToken cancellationToken = default
+  )
+  {
+    //language=graphql
+    const string QUERY = """
+      query ModelPermissions($projectId: String!, $modelId: String!) {
+        data:project(id: $projectId) {
+          data:model(id: $modelId) {
+            data:permissions {
+              data:canCreateIngestion {
+                authorized
+                code
+                message
+              }
+            }
+          }
+        }
+      }
+      """;
+    GraphQLRequest request = new() { Query = QUERY, Variables = new { projectId, modelId } };
+
+    var response = await _client
+      .ExecuteGraphQLRequest<
+        RequiredResponse<RequiredResponse<RequiredResponse<RequiredResponse<PermissionCheckResult>>>>
+      >(request, cancellationToken)
+      .ConfigureAwait(false);
+    return response.data.data.data.data;
+  }
 }

src/Speckle.Sdk/Api/GraphQL/Resources/graphql.config.yml

@@ -1,2 +1,2 @@
-schema: https://app.speckle.systems/graphql
+schema: https://latest.speckle.systems/graphql
 documents: '**/*.graphql'

tests/Speckle.Sdk.Tests.Integration/Api/GraphQL/Resources/ModelResourceTests.cs

@@ -141,4 +141,23 @@ public class ModelResourceTests : IAsyncLifetime
     guestResult.canCreateVersion.authorized.Should().Be(false);
     guestResult.canDelete.authorized.Should().Be(false);
   }
+
+  [Fact]
+  [Trait("Server", "Internal")]
+  public async Task TestCanCreateModelIngestion_InternalServer()
+  {
+    var ownerResult = await Sut.CanCreateModelIngestion(_project.id, _model.id);
+    ownerResult.authorized.Should().Be(true);
+  }
+
+  [Fact]
+  [Trait("Server", "Public")]
+  public async Task TestCanCreateModelIngestion_PublicServer_Throws()
+  {
+    var ex = await Assert.ThrowsAsync<AggregateException>(async () =>
+      await Sut.CanCreateModelIngestion(_project.id, _model.id)
+    );
+    ex.InnerExceptions.Should().HaveCount(1);
+    ex.InnerExceptions.Should().AllBeOfType<SpeckleGraphQLInvalidQueryException>();
+  }
 }