1.1.0 (#24)

Author: ellizio

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [1.1.0]
+- odata-cli 0.3.1 support
+- UI improvements and fixes
+
 ## [1.0.1]
 - odata-cli exceptions handling
 

README.md

@@ -4,37 +4,25 @@
 
 <p align="center">
   <a href="https://plugins.jetbrains.com/plugin/24117-odata-cli-ui" target="_blank">
-    <img src="/img/marketplace.png">
+    <img src="/img/marketplace.png" alt="Marketplace link">
   </a>
 </p>
 
 ---
 
 ## Installation
 
-1. Install plugin from [Marketplace](https://plugins.jetbrains.com/plugin/24117-odata-cli-ui) or download from [Releases page](https://github.com/ellizio/rider--plugin--odata-cli-ui/releases) and install manually
+1. Install plugin from [Marketplace](https://plugins.jetbrains.com/plugin/24117-odata-cli-ui) or download from [Releases page](https://github.com/ellizio/odata-cli-ui/releases) and install manually
 2. Install the latest version of the OData CLI tool with the command `dotnet tool install -g Microsoft.OData.Cli`
 
 ## Usage
 
-1. Open solution
-2. Select `OData Reference...` action under project or Web Reference context menu\
-![](/img/action.png)
-3. Fill required `Service name` and `Metadata source` and other optional parameters according [documentation](https://learn.microsoft.com/en-us/odata/odatacli/getting-started#options-1)\
-![](/img/dialog.png)
-4. Click `OK` and wait until generation finishes
-![](/img/terminal.png)
-
-## ⚠️ Known Restrictions
-
-1. ✅ Waiting for release with fix\
-Output metadata .xml file is always named `OData ServiceCsdl.xml` which will throw a runtime exception. See more [https://github.com/OData/ODataConnectedService/issues/384](https://github.com/OData/ODataConnectedService/issues/384)\
-There is a workaround:\
-`a.` Rename `OData ServiceCsdl.xml` to `<Service name>Csdl.xml`, where `<Service name>` is value from OData CLI UI dialog\
-`b.` Adjust embedded resource path in `.csproj` file\
-`c.` Find `GeneratedEdmModel.filePath` constant in `Reference.cs` and change value from `OData ServiceCsdl.xml` to `<Service name>Csdl.xml`, where `<Service name>` is value from OData CLI UI dialog
+![](/img/step1.png)
+![](/img/step2.png)
+![](/img/step3.png)
+![](/img/step4.png)
 
 ## Additional References
 
-- [Changelog](https://github.com/ellizio/rider--plugin--odata-cli-ui/blob/master/CHANGELOG.md)
+- [Changelog](https://github.com/ellizio/odata-cli-ui/blob/master/CHANGELOG.md)
 - [OData CLI](https://learn.microsoft.com/en-us/odata/odatacli/getting-started)

gradle.properties

@@ -4,7 +4,7 @@
 DotnetPluginId=ReSharperPlugin.ODataCliUi
 DotnetSolution=ReSharperPlugin.ODataCliUi.sln
 RiderPluginId=ru.ellizio.odatacliui
-PluginVersion=1.0.1
+PluginVersion=1.1.0
 
 BuildConfiguration=Debug
 

img/action.png

@@ -5,9 +5,14 @@ import com.jetbrains.rider.model.nova.ide.SolutionModel
 
 @Suppress("unused")
 object ProtocolModel : Ext(SolutionModel.Solution) {
-    private val CliTool = structdef {
+    private val DotnetToolVersionDefinition = structdef {
+        field("major", PredefinedType.int)
+        field("minor", PredefinedType.int)
+        field("patch", PredefinedType.int)
+    }
+    private val DotnetToolDefinition = structdef {
         field("installed", PredefinedType.bool)
-        field("version", PredefinedType.string.nullable)
+        field("version", DotnetToolVersionDefinition.nullable)
     }
 
     private val EmbeddedResourceDefinition = structdef {
@@ -16,7 +21,7 @@ object ProtocolModel : Ext(SolutionModel.Solution) {
     }
 
     init {
-        call("getODataCliTool", PredefinedType.void, CliTool)
+        call("getODataCliTool", PredefinedType.void, DotnetToolDefinition)
         call("addEmbeddedResource", EmbeddedResourceDefinition, PredefinedType.void)
     }
 }

img/dialog.png

@@ -7,15 +7,15 @@
 namespace ReSharperPlugin.ODataCliUi;
 
 [SolutionComponent]
-public class Tracker
+public class DotnetToolsTracker
 {
     private readonly JetFastSemiReenterableRWLock _lock = new();
     private readonly Lifetime _lifetime;
     private readonly SolutionDotnetToolsTracker _dotnetToolsTracker;
 
-    public event Action<DotNetToolCache> DotNetToolCacheChanged;
+    public event Action<DotNetToolCache> DotnetToolsCacheChanged;
 
-    public Tracker(Lifetime lifetime, SolutionDotnetToolsTracker dotnetToolsTracker)
+    public DotnetToolsTracker(Lifetime lifetime, SolutionDotnetToolsTracker dotnetToolsTracker)
     {
         _lifetime = lifetime;
         _dotnetToolsTracker = dotnetToolsTracker;
@@ -30,7 +30,7 @@ public void Start()
 
             using var _ = _lock.UsingWriteLock();
             var cache = args.New;
-            DotNetToolCacheChanged?.Invoke(cache);
+            DotnetToolsCacheChanged?.Invoke(cache);
         });
     }
 }

img/step1.png

@@ -16,20 +16,20 @@ namespace ReSharperPlugin.ODataCliUi;
 public sealed class PluginHost : IDisposable
 {
     private readonly ISolution _solution;
-    private readonly Tracker _tracker;
+    private readonly DotnetToolsTracker _dotnetToolsTracker;
 
-    private CliTool _odataCliTool;
+    private DotnetToolDefinition _odataCliTool;
 
-    public PluginHost(ISolution solution, Tracker tracker)
+    public PluginHost(ISolution solution, DotnetToolsTracker dotnetToolsTracker)
     {
         _solution = solution;
         var protocolModel = solution.GetProtocolSolution().GetProtocolModel();
         protocolModel.GetODataCliTool.SetSync(GetODataCliTool);
         protocolModel.AddEmbeddedResource.SetVoidAsync(AddEmbeddedResourceAsync);
 
-        _tracker = tracker;
-        tracker.DotNetToolCacheChanged += OnDotNetToolCacheChanged;
-        tracker.Start();
+        _dotnetToolsTracker = dotnetToolsTracker;
+        dotnetToolsTracker.DotnetToolsCacheChanged += OnDotnetToolsCacheChanged;
+        dotnetToolsTracker.Start();
     }
 
     private Task AddEmbeddedResourceAsync(Lifetime lifetime, EmbeddedResourceDefinition definition)
@@ -46,21 +46,21 @@ private Task AddEmbeddedResourceAsync(Lifetime lifetime, EmbeddedResourceDefinit
         return Task.CompletedTask;
     }
 
-    private CliTool GetODataCliTool(Lifetime lifetime, Unit unit) => _odataCliTool;
+    private DotnetToolDefinition GetODataCliTool(Lifetime lifetime, Unit unit) => _odataCliTool;
 
-    private void OnDotNetToolCacheChanged(DotNetToolCache cache)
+    private void OnDotnetToolsCacheChanged(DotNetToolCache cache)
     {
         var tool = cache.ToolGlobalCache.GetGlobalTool(Constants.MicrosoftODataCliPackageId)?.FirstOrDefault();
         _odataCliTool = tool is null
-            ? _odataCliTool = new CliTool(false, null)
-            : _odataCliTool = new CliTool(true, $"Global, {tool.Version}");
+            ? _odataCliTool = new DotnetToolDefinition(false, null)
+            : _odataCliTool = new DotnetToolDefinition(true, new DotnetToolVersionDefinition(tool.Version.Major, tool.Version.Minor, tool.Version.Patch));
     }
 
     public void Dispose()
     {
-        if (_tracker is not null)
+        if (_dotnetToolsTracker is not null)
         {
-            _tracker.DotNetToolCacheChanged -= OnDotNetToolCacheChanged;
+            _dotnetToolsTracker.DotnetToolsCacheChanged -= OnDotnetToolsCacheChanged;
         }
     }
 }

img/step2.png

@@ -8,7 +8,9 @@ import com.intellij.ui.dsl.builder.*
 import ru.ellizio.odatacliui.Constants
 import ru.ellizio.odatacliui.UiBundle
 import ru.ellizio.odatacliui.extensions.emptyText
+import ru.ellizio.odatacliui.extensions.humanize
 import ru.ellizio.odatacliui.models.CliDialogModel
+import ru.ellizio.odatacliui.models.validators.CliDialogValidators
 import javax.swing.JComponent
 
 class CliDialog(private val model: CliDialogModel) : DialogWrapper(false) {
@@ -47,26 +49,29 @@ class CliDialog(private val model: CliDialogModel) : DialogWrapper(false) {
         tabbedPane.addTab(UiBundle.text("cli.tab.generation"), generationTab)
         tabbedPane.addTab(UiBundle.text("cli.tab.request"), requestTab)
 
+        val version = if (!model.odataCliTool.installed) UiBundle.text("cli.cli-version.label-value.not-installed")
+            else "${UiBundle.text("cli.cli-version.label-value.global")}, ${model.odataCliTool.version?.humanize()}"
+
         return panel {
             row {
-                label(model.odataCliTool.version ?: UiBundle.text("cli.cli-version.label-value.not-installed"))
+                label(version)
                     .label(UiBundle.text("cli.cli-version.label"))
                     .comment(UiBundle.text("cli.cli-version.comment"))
             }.bottomGap(BottomGap.SMALL)
             row(UiBundle.text("cli.service-name.row")) {
                 textField()
                     .align(AlignX.FILL)
                     .bindText(model.serviceName)
-                    .validationOnInput(model.validator.serviceNameValidation())
-                    .validationOnApply(model.validator.serviceNameValidation())
+                    .validationOnInput(CliDialogValidators.serviceNameValidator())
+                    .validationOnApply(CliDialogValidators.serviceNameValidator())
             }
             row(UiBundle.text("cli.metadata-source.row")) {
                 textFieldWithBrowseButton(fileChooserDescriptor = FileChooserDescriptorFactory.createSingleFileDescriptor("xml"))
                     .align(AlignX.FILL)
                     .comment(UiBundle.text("cli.metadata-source.comment"), Int.MAX_VALUE)
                     .bindText(model.metadataUri)
-                    .validationOnInput(model.validator.metadataUriValidation())
-                    .validationOnApply(model.validator.metadataUriValidation())
+                    .validationOnInput(CliDialogValidators.metadataUriValidator())
+                    .validationOnApply(CliDialogValidators.metadataUriValidator())
             }.bottomGap(BottomGap.SMALL)
             row {
                 cell(tabbedPane)
@@ -87,8 +92,8 @@ class CliDialog(private val model: CliDialogModel) : DialogWrapper(false) {
                 .align(AlignX.FILL)
                 .comment(UiBundle.text("cli.namespace-prefix.comment"))
                 .bindText(model.namespacePrefix)
-                .validationOnInput(model.validator.namespacePrefixValidation())
-                .validationOnApply(model.validator.namespacePrefixValidation())
+                .validationOnInput(CliDialogValidators.namespacePrefixValidator())
+                .validationOnApply(CliDialogValidators.namespacePrefixValidator())
         }
         row("--excluded-operation-imports") {
             textField()
@@ -154,6 +159,8 @@ class CliDialog(private val model: CliDialogModel) : DialogWrapper(false) {
                 .emptyText(UiBundle.text("cli.proxy.empty-text"))
                 .comment(UiBundle.text("cli.proxy.comment"))
                 .bindText(model.proxy)
+                .validationOnInput(CliDialogValidators.proxyValidator())
+                .validationOnApply(CliDialogValidators.proxyValidator())
         }
     }.apply {
         registerValidators(disposable)

img/step3.png

@@ -0,0 +1,18 @@
+package ru.ellizio.odatacliui.extensions
+
+import com.jetbrains.rd.ide.model.DotnetToolVersionDefinition
+
+fun DotnetToolVersionDefinition.humanize() : String = "$major.$minor.$patch"
+
+fun DotnetToolVersionDefinition.greaterOrEquals(major: Int, minor: Int, patch: Int) : Boolean {
+    if (this.major > major)
+        return true
+
+    if (this.major == major && this.minor > minor)
+        return true
+
+    if (this.major == major && this.minor == minor && this.patch >= patch)
+        return true
+
+    return false
+}

img/step4.png

@@ -2,31 +2,34 @@ package ru.ellizio.odatacliui.models
 
 import com.intellij.execution.configurations.GeneralCommandLine
 import com.intellij.openapi.project.Project
-import com.jetbrains.rd.ide.model.CliTool
+import com.jetbrains.rd.ide.model.DotnetToolDefinition
 import com.jetbrains.rd.ide.model.protocolModel
 import com.jetbrains.rider.model.dotNetActiveRuntimeModel
 import ru.ellizio.odatacliui.Constants
 import ru.ellizio.odatacliui.extensions.dotnetAddPackageCommand
-import ru.ellizio.odatacliui.models.validators.CliDialogModelValidator
 import ru.ellizio.odatacliui.terminal.BatchCommandLine
 import ru.ellizio.odatacliui.terminal.builders.BatchCommandLineBuilder
 import com.jetbrains.rider.projectView.solution
+import ru.ellizio.odatacliui.extensions.greaterOrEquals
 import ru.ellizio.odatacliui.terminal.builders.CommandLineBuilder
 import ru.ellizio.odatacliui.utils.DotnetToolsUtils
 import kotlin.io.path.Path
 
 private const val CONNECTED_SERVICES = "Connected Services"
-private const val CSDL_NAME = "OData ServiceCsdl.xml"
+private const val CSDL_NAME_LEGACY = "OData ServiceCsdl.xml"
+private const val CSDL_NAME_SUFFIX = "Csdl.xml"
 
 class CliDialogModel(project: Project, private val actionMetadata: ActionMetadata) {
-    val validator = CliDialogModelValidator()
+    val odataCliTool: DotnetToolDefinition
+    private val dotnetCliPath: String?
 
-    val odataCliTool: CliTool
-    val dotnetCliPath: String?
+    private val atLeast031: Boolean
 
     init {
         odataCliTool = project.solution.protocolModel.getODataCliTool.sync(Unit)
         dotnetCliPath = project.solution.dotNetActiveRuntimeModel.activeRuntime.valueOrNull?.dotNetCliExePath
+
+        atLeast031 = odataCliTool.version?.greaterOrEquals(0, 3, 1) ?: false
     }
 
     val serviceName = MutableProperty("")
@@ -47,10 +50,14 @@ class CliDialogModel(project: Project, private val actionMetadata: ActionMetadat
 
     private fun getOutputDirectory(): String = Path(Path(actionMetadata.projectPath).parent.toString(), CONNECTED_SERVICES, serviceName.get()).toString()
 
-    fun getCsdlPath(): String = Path(CONNECTED_SERVICES, serviceName.get(), CSDL_NAME).toString()
+    fun getCsdlPath(): String {
+        val csdl = if (atLeast031) "${serviceName.get()}$CSDL_NAME_SUFFIX" else CSDL_NAME_LEGACY
+        return Path(CONNECTED_SERVICES, serviceName.get(), csdl).toString()
+    }
 
     fun buildODataCliCommand(): GeneralCommandLine = CommandLineBuilder(DotnetToolsUtils.getToolDefaultPath("odata-cli"), "generate")
         .withParameter("--metadata-uri", metadataUri.get())
+        .withParameter("--service-name", serviceName.get(), atLeast031)
         .withParameter("--file-name", fileName.get())
         .withParameter("--custom-headers", customHeaders.get())
         .withParameter("--proxy", proxy.get())

img/terminal.png

@@ -0,0 +1,45 @@
+package ru.ellizio.odatacliui.models.validators
+
+import com.intellij.openapi.ui.TextFieldWithBrowseButton
+import com.intellij.openapi.ui.ValidationInfo
+import com.intellij.ui.layout.ValidationInfoBuilder
+import javax.swing.JTextField
+
+object CliDialogValidators {
+    private val serviceNameRegex = Regex("^[0-9a-zA-Z_\\-. ]+\$")
+    private val proxyRegex = Regex("^(\\w+\\\\\\w+(:\\w+)?@)?\\w+:\\d+\$")
+
+    fun serviceNameValidator(): ValidationInfoBuilder.(JTextField) -> ValidationInfo? = {
+        if (it.text.isBlank())
+            error("Service name must not be empty")
+        else if (it.text.startsWith(' '))
+            error("Service name must not start with a space")
+        else if (it.text.endsWith(' '))
+            error("Service name must not end with a space")
+        else if (!serviceNameRegex.matches(it.text))
+            error("Service name must be in a valid format")
+        else
+            null
+    }
+
+    fun metadataUriValidator(): ValidationInfoBuilder.(TextFieldWithBrowseButton) -> ValidationInfo? = {
+        if (it.text.isBlank())
+            error("Metadata source must not be empty")
+        else
+            null
+    }
+
+    fun namespacePrefixValidator(): ValidationInfoBuilder.(JTextField) -> ValidationInfo? = {
+        if (it.text.contains(' '))
+            error("Namespace prefix must not contain spaces")
+        else
+            null
+    }
+
+    fun proxyValidator(): ValidationInfoBuilder.(JTextField) -> ValidationInfo? = {
+        if (!proxyRegex.matches(it.text))
+            error("Proxy must be in a valid format")
+        else
+            null
+    }
+}