| | | 1 | | using System.Collections; |
| | | 2 | | using NGql.Core.Builders; |
| | | 3 | | using NGql.Core.Extensions; |
| | | 4 | | |
| | | 5 | | namespace NGql.Core.Abstractions; |
| | | 6 | | |
| | | 7 | | /// <summary> |
| | | 8 | | /// Represents a GraphQL Query Block. |
| | | 9 | | /// </summary> |
| | | 10 | | public sealed class QueryBlock |
| | | 11 | | { |
| | | 12 | | private readonly string _prefix; |
| | | 13 | | private readonly SortedDictionary<string, object> _arguments; |
| | | 14 | | private readonly SortedSet<Variable> _variables; |
| | | 15 | | private readonly List<object> _fieldsList; |
| | | 16 | | |
| | | 17 | | /// <summary> |
| | | 18 | | /// The list of fields to retrieve from GraphQL. |
| | | 19 | | /// </summary> |
| | 462 | 20 | | public IReadOnlyList<object> FieldsList => _fieldsList; |
| | | 21 | | |
| | | 22 | | /// <summary> |
| | | 23 | | /// The collection of arguments related to <see cref="FieldsList"/>. |
| | | 24 | | /// </summary> |
| | 483 | 25 | | public IReadOnlyDictionary<string, object> Arguments => _arguments; |
| | | 26 | | |
| | | 27 | | /// <summary> |
| | | 28 | | /// The collection of variables related to <see cref="FieldsList"/> or <see cref="Arguments"/>. |
| | | 29 | | /// </summary> |
| | 546 | 30 | | public IReadOnlyCollection<Variable> Variables => _variables; |
| | | 31 | | |
| | | 32 | | /// <summary> |
| | | 33 | | /// The Query name. |
| | | 34 | | /// </summary> |
| | 588 | 35 | | public string Name { get; } |
| | | 36 | | |
| | | 37 | | /// <summary> |
| | | 38 | | /// The Query alias. |
| | | 39 | | /// </summary> |
| | 792 | 40 | | public string? Alias { get; } |
| | | 41 | | |
| | | 42 | | /// <summary> |
| | | 43 | | /// Indicates if the query is empty. |
| | | 44 | | /// </summary> |
| | | 45 | | internal bool IsEmpty = false; |
| | | 46 | | |
| | | 47 | | /// <summary> |
| | | 48 | | /// Adds the variable with give name into <see cref="Variables"/> part of the query. |
| | | 49 | | /// </summary> |
| | | 50 | | /// <param name="variable">The variable</param> |
| | | 51 | | public void AddVariable(Variable variable) |
| | 30 | 52 | | => HandleAddVariable(variable); |
| | | 53 | | |
| | | 54 | | /// <summary> |
| | | 55 | | /// Adds the variable with give name into <see cref="Variables"/> part of the query. |
| | | 56 | | /// </summary> |
| | | 57 | | /// <param name="name">The variable name</param> |
| | | 58 | | /// <param name="type">The value of the variable</param> |
| | | 59 | | public void AddVariable(string name, string type) |
| | 30 | 60 | | => HandleAddVariable(new Variable(name, type)); |
| | | 61 | | |
| | | 62 | | /// <summary> |
| | | 63 | | /// Adds the given generic list to the <see cref="FieldsList"/> part of the query. |
| | | 64 | | /// </summary> |
| | | 65 | | /// <remarks> |
| | | 66 | | /// Accepts any type of list, but must contain one of supported types of data. |
| | | 67 | | /// </remarks> |
| | | 68 | | /// <param name="selectList">Generic list of select fields.</param> |
| | | 69 | | public void AddField(IEnumerable<object> selectList) |
| | 27 | 70 | | => HandleAddField(selectList); |
| | | 71 | | |
| | | 72 | | /// <summary> |
| | | 73 | | /// Adds the given list of strings to the <see cref="FieldsList"/> part of the query. |
| | | 74 | | /// </summary> |
| | | 75 | | /// <param name="selects">List of strings.</param> |
| | | 76 | | /// <returns>Query</returns> |
| | | 77 | | public void AddField(params string[] selects) |
| | 195 | 78 | | => HandleAddField(selects); |
| | | 79 | | |
| | | 80 | | /// <summary> |
| | | 81 | | /// Adds the given sub query to the <see cref="FieldsList"/> part of the query. |
| | | 82 | | /// </summary> |
| | | 83 | | /// <param name="subQuery">A sub-query.</param> |
| | | 84 | | /// <returns>Query</returns> |
| | | 85 | | public void AddField(QueryBlock subQuery) |
| | 216 | 86 | | => HandleAddField(subQuery); |
| | | 87 | | |
| | | 88 | | /// <summary> |
| | | 89 | | /// Adds the given key into <see cref="Arguments"/> part of the query. |
| | | 90 | | /// </summary> |
| | | 91 | | /// <param name="key">The Parameter Name</param> |
| | | 92 | | /// <param name="where">The value of the parameter, primitive or object</param> |
| | | 93 | | /// <returns></returns> |
| | | 94 | | public void AddArgument(string key, object where) |
| | 108 | 95 | | => HandleAddArgument(key, where); |
| | | 96 | | |
| | | 97 | | /// <summary> |
| | | 98 | | /// Add a dict of key value pairs <string, object> into <see cref="Arguments"/> part of the query. |
| | | 99 | | /// </summary> |
| | | 100 | | /// <param name="dict">An existing Dictionary that takes <string, object></param> |
| | | 101 | | /// <returns>Query</returns> |
| | | 102 | | /// <throws>DuplicateKeyException and others</throws> |
| | | 103 | | public void AddArgument(IReadOnlyDictionary<string, object> dict) |
| | | 104 | | { |
| | 216 | 105 | | foreach (var (key, value) in dict) |
| | 81 | 106 | | HandleAddArgument(key, value); |
| | 27 | 107 | | } |
| | | 108 | | |
| | | 109 | | /// <summary> |
| | | 110 | | /// Initializes a new instance of the <see cref="QueryBlock"/> class. |
| | | 111 | | /// </summary> |
| | 522 | 112 | | public QueryBlock(string name, string prefix = "", string? alias = null, params Variable[]? variables) |
| | | 113 | | { |
| | 522 | 114 | | _prefix = prefix; |
| | 522 | 115 | | Name = name; |
| | 522 | 116 | | Alias = alias; |
| | | 117 | | |
| | 522 | 118 | | _fieldsList = new List<object>(); |
| | 624 | 119 | | _variables = variables is null ? [] : [.. variables.DistinctBy(x => x.Name)]; |
| | 522 | 120 | | _arguments = new SortedDictionary<string, object>(StringComparer.OrdinalIgnoreCase); |
| | 522 | 121 | | } |
| | | 122 | | |
| | | 123 | | public override string ToString() |
| | | 124 | | { |
| | 207 | 125 | | var builder = QueryTextBuilder.GetFromPool(); |
| | | 126 | | try |
| | | 127 | | { |
| | 207 | 128 | | return builder.Build(this, prefix: _prefix); |
| | | 129 | | } |
| | | 130 | | finally |
| | | 131 | | { |
| | 207 | 132 | | QueryTextBuilder.ReturnToPool(builder); |
| | 207 | 133 | | } |
| | 207 | 134 | | } |
| | | 135 | | |
| | | 136 | | private void HandleAddField(object value) |
| | | 137 | | { |
| | | 138 | | switch (value) |
| | | 139 | | { |
| | | 140 | | case QueryBlock subQuery: |
| | 222 | 141 | | AddSubQuery(subQuery); |
| | 222 | 142 | | return; |
| | | 143 | | case string field: |
| | 303 | 144 | | AddStringField(field); |
| | 303 | 145 | | return; |
| | | 146 | | case IList list: |
| | 222 | 147 | | AddListItems(list); |
| | 219 | 148 | | return; |
| | | 149 | | default: |
| | 3 | 150 | | throw new InvalidOperationException("Unsupported Field type found, must be a `string` or `QueryBlock`"); |
| | | 151 | | } |
| | | 152 | | } |
| | | 153 | | |
| | | 154 | | private void AddSubQuery(QueryBlock subQuery) |
| | | 155 | | { |
| | 558 | 156 | | foreach (var variable in subQuery.Variables) |
| | | 157 | | { |
| | 57 | 158 | | _variables.Add(variable); |
| | | 159 | | } |
| | 222 | 160 | | _fieldsList.Add(subQuery); |
| | 222 | 161 | | } |
| | | 162 | | |
| | | 163 | | private void AddStringField(string field) |
| | | 164 | | { |
| | 321 | 165 | | if (string.IsNullOrWhiteSpace(field)) return; |
| | | 166 | | |
| | 285 | 167 | | var insertIndex = _fieldsList.OfType<string>() |
| | 120 | 168 | | .TakeWhile(existing => string.Compare(existing, field, StringComparison.OrdinalIgnoreCase) < 0) |
| | 285 | 169 | | .Count(); |
| | 285 | 170 | | _fieldsList.Insert(insertIndex, field); |
| | 285 | 171 | | } |
| | | 172 | | |
| | | 173 | | private void AddListItems(IList list) |
| | | 174 | | { |
| | 222 | 175 | | var sortedItems = list.Cast<object>() |
| | 171 | 176 | | .OrderBy(x => x switch |
| | 171 | 177 | | { |
| | 159 | 178 | | string s => s, |
| | 6 | 179 | | QueryBlock q => q.Name, |
| | 6 | 180 | | _ => x.ToString() |
| | 171 | 181 | | }) |
| | 222 | 182 | | .ToList(); |
| | | 183 | | |
| | 1065 | 184 | | foreach (var item in sortedItems) |
| | | 185 | | { |
| | 312 | 186 | | HandleAddField(item); |
| | | 187 | | } |
| | 219 | 188 | | } |
| | | 189 | | |
| | | 190 | | private void HandleAddVariable(Variable variable) |
| | | 191 | | { |
| | 60 | 192 | | _variables.Add(variable); |
| | 60 | 193 | | } |
| | | 194 | | |
| | | 195 | | private void HandleAddArgument(string key, object value) |
| | | 196 | | { |
| | 189 | 197 | | Helpers.ExtractVariablesFromValue(value, _variables); |
| | 189 | 198 | | var sortedValue = Helpers.SortArgumentValue(value); |
| | | 199 | | |
| | 189 | 200 | | _arguments[key] = sortedValue!; // SortArgumentValue preserves non-null input |
| | 189 | 201 | | } |
| | | 202 | | } |