Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
| 1 | import { describe, expect, it } from '@effect/vitest'; |
| 2 | import { Effect } from 'effect'; |
| 3 | import { CompareSemverError, semverComparator } from 'src/effects/compare-semver'; |
| 4 | |
| 5 | describe('compare-semver.ts', () => { |
| 6 | describe('semverComparator', () => { |
| 7 | describe('Basic Comparisons', () => { |
| 8 | it.effect('should return -1 when first version is older', () => |
| 9 | Effect.gen(function* () { |
| 10 | const result = yield* semverComparator('1.0.0', '2.0.0'); |
| 11 | expect(result).toBe(-1); |
| 12 | }) |
| 13 | ); |
| 14 | |
| 15 | it.effect('should return 1 when first version is newer', () => |
| 16 | Effect.gen(function* () { |
| 17 | const result = yield* semverComparator('2.0.0', '1.0.0'); |
| 18 | expect(result).toBe(1); |
| 19 | }) |
| 20 | ); |
| 21 | |
| 22 | it.effect('should return 0 when versions are equal', () => |
| 23 | Effect.gen(function* () { |
| 24 | const result = yield* semverComparator('1.0.0', '1.0.0'); |
| 25 | expect(result).toBe(0); |
| 26 | }) |
| 27 | ); |
| 28 | }); |
| 29 | |
| 30 | describe('Version Prefix Handling', () => { |
| 31 | it.effect('should handle v prefix on first version', () => |
| 32 | Effect.gen(function* () { |
| 33 | const result = yield* semverComparator('v1.0.0', '2.0.0'); |
| 34 | expect(result).toBe(-1); |
| 35 | }) |
| 36 | ); |
| 37 | |
| 38 | it.effect('should handle v prefix on second version', () => |
| 39 | Effect.gen(function* () { |
| 40 | const result = yield* semverComparator('1.0.0', 'v2.0.0'); |
| 41 | expect(result).toBe(-1); |
| 42 | }) |
| 43 | ); |
| 44 | |
| 45 | it.effect('should handle v prefix on both versions', () => |
| 46 | Effect.gen(function* () { |
| 47 | const result = yield* semverComparator('v1.0.0', 'v2.0.0'); |
| 48 | expect(result).toBe(-1); |
| 49 | }) |
| 50 | ); |
| 51 | |
| 52 | it.effect('should handle mixed v prefix scenarios', () => |
| 53 | Effect.gen(function* () { |
| 54 | const result = yield* semverComparator('v2.0.0', '1.0.0'); |
| 55 | expect(result).toBe(1); |
| 56 | }) |
| 57 | ); |
| 58 | |
| 59 | it.effect('should handle equal versions with and without v prefix', () => |
| 60 | Effect.gen(function* () { |
| 61 | const result = yield* semverComparator('v1.0.0', '1.0.0'); |
| 62 | expect(result).toBe(0); |
| 63 | }) |
| 64 | ); |
| 65 | }); |
| 66 | |
| 67 | describe('Cli Prefix Handling', () => { |
| 68 | it.effect('should handle cli@ prefix on first version', () => |
| 69 | Effect.gen(function* () { |
| 70 | const result = yield* semverComparator('cli@1.0.0', '2.0.0'); |
| 71 | expect(result).toBe(-1); |
| 72 | }) |
| 73 | ); |
| 74 | |
| 75 | it.effect('should handle cli@ prefix on second version', () => |
| 76 | Effect.gen(function* () { |
| 77 | const result = yield* semverComparator('1.0.0', 'cli@2.0.0'); |
| 78 | expect(result).toBe(-1); |
| 79 | }) |
| 80 | ); |
| 81 | |
| 82 | it.effect('should handle cli@ prefix on both versions', () => |
| 83 | Effect.gen(function* () { |
| 84 | const result = yield* semverComparator('cli@1.0.0', 'cli@2.0.0'); |
| 85 | expect(result).toBe(-1); |
| 86 | }) |
| 87 | ); |
| 88 | |
| 89 | it.effect('should handle mixed cli@ prefix scenarios', () => |
| 90 | Effect.gen(function* () { |
| 91 | const result = yield* semverComparator('cli@2.0.0', '1.0.0'); |
| 92 | expect(result).toBe(1); |
| 93 | }) |
| 94 | ); |
| 95 | |
| 96 | it.effect('should handle equal versions with and without cli@ prefix', () => |
| 97 | Effect.gen(function* () { |
| 98 | const result = yield* semverComparator('cli@1.0.0', '1.0.0'); |
| 99 | expect(result).toBe(0); |
| 100 | }) |
| 101 | ); |
| 102 | }); |
| 103 | |
| 104 | describe('Semantic Version Components', () => { |
| 105 | it.effect('should compare major versions correctly', () => |
| 106 | Effect.gen(function* () { |
| 107 | const result = yield* semverComparator('2.0.0', '1.9.9'); |
| 108 | expect(result).toBe(1); |
| 109 | }) |
| 110 | ); |
| 111 | |
| 112 | it.effect('should compare minor versions correctly', () => |
| 113 | Effect.gen(function* () { |
| 114 | const result = yield* semverComparator('1.2.0', '1.1.9'); |
| 115 | expect(result).toBe(1); |
| 116 | }) |
| 117 | ); |
| 118 | |
| 119 | it.effect('should compare patch versions correctly', () => |
| 120 | Effect.gen(function* () { |
| 121 | const result = yield* semverComparator('1.0.2', '1.0.1'); |
| 122 | expect(result).toBe(1); |
| 123 | }) |
| 124 | ); |
| 125 | }); |
| 126 | |
| 127 | describe('Pre-release Versions', () => { |
| 128 | it.effect('should handle alpha versions', () => |
| 129 | Effect.gen(function* () { |
| 130 | const result = yield* semverComparator('1.0.0-alpha.1', '1.0.0-alpha.2'); |
| 131 | expect(result).toBe(-1); |
| 132 | }) |
| 133 | ); |
| 134 | |
| 135 | it.effect('should handle beta versions', () => |
| 136 | Effect.gen(function* () { |
| 137 | const result = yield* semverComparator('1.0.0-beta.2', '1.0.0-beta.1'); |
| 138 | expect(result).toBe(1); |
| 139 | }) |
| 140 | ); |
| 141 | |
| 142 | it.effect('should handle rc versions', () => |
| 143 | Effect.gen(function* () { |
| 144 | const result = yield* semverComparator('1.0.0-rc.1', '1.0.0-rc.1'); |
| 145 | expect(result).toBe(0); |
| 146 | }) |
| 147 | ); |
| 148 | |
| 149 | it.effect('should prioritize release over pre-release', () => |
| 150 | Effect.gen(function* () { |
| 151 | const result = yield* semverComparator('1.0.0', '1.0.0-alpha.1'); |
| 152 | expect(result).toBe(1); |
| 153 | }) |
| 154 | ); |
| 155 | |
| 156 | it.effect('should compare pre-release identifiers', () => |
| 157 | Effect.gen(function* () { |
| 158 | const result = yield* semverComparator('1.0.0-alpha', '1.0.0-beta'); |
| 159 | expect(result).toBe(-1); |
| 160 | }) |
| 161 | ); |
| 162 | }); |
| 163 | |
| 164 | describe('Build Metadata', () => { |
| 165 | it.effect('should ignore build metadata in comparison', () => |
| 166 | Effect.gen(function* () { |
| 167 | const result = yield* semverComparator('1.0.0+build.1', '1.0.0+build.2'); |
| 168 | expect(result).toBe(0); |
| 169 | }) |
| 170 | ); |
| 171 | |
| 172 | it.effect('should compare versions with build metadata correctly', () => |
| 173 | Effect.gen(function* () { |
| 174 | const result = yield* semverComparator('1.0.1+build.1', '1.0.0+build.2'); |
| 175 | expect(result).toBe(1); |
| 176 | }) |
| 177 | ); |
| 178 | |
| 179 | it.effect('should handle pre-release with build metadata', () => |
| 180 | Effect.gen(function* () { |
| 181 | const result = yield* semverComparator('1.0.0-alpha.1+build.1', '1.0.0-alpha.2+build.2'); |
| 182 | expect(result).toBe(-1); |
| 183 | }) |
| 184 | ); |
| 185 | }); |
| 186 | |
| 187 | describe('Complex Version Scenarios', () => { |
| 188 | it.effect('should handle multi-digit versions', () => |
| 189 | Effect.gen(function* () { |
| 190 | const result = yield* semverComparator('10.15.20', '9.99.99'); |
| 191 | expect(result).toBe(1); |
| 192 | }) |
| 193 | ); |
| 194 | |
| 195 | it.effect('should accept zero-padded components', () => |
| 196 | Effect.gen(function* () { |
| 197 | const result = yield* Effect.flip(semverComparator('1.01.0', '1.1.0')); |
| 198 | expect(result).toBeInstanceOf(CompareSemverError); |
| 199 | expect((result as CompareSemverError).message).toContain('Failed to compare versions'); |
| 200 | }) |
| 201 | ); |
| 202 | |
| 203 | it.effect('should handle long pre-release identifiers', () => |
| 204 | Effect.gen(function* () { |
| 205 | const result = yield* semverComparator( |
| 206 | '1.0.0-alpha.very.long.identifier', |
| 207 | '1.0.0-alpha.very.long.identifier.2' |
| 208 | ); |
| 209 | expect(result).toBe(-1); |
| 210 | }) |
| 211 | ); |
| 212 | }); |
| 213 | |
| 214 | describe('Edge Cases', () => { |
| 215 | it.effect('should handle identical versions', () => |
| 216 | Effect.gen(function* () { |
| 217 | const result = yield* semverComparator('1.2.3', '1.2.3'); |
| 218 | expect(result).toBe(0); |
| 219 | }) |
| 220 | ); |
| 221 | |
| 222 | it.effect('should reject versions with leading zeros', () => |
| 223 | Effect.gen(function* () { |
| 224 | // The semver library considers leading zeros as invalid |
| 225 | const result = yield* Effect.flip(semverComparator('01.02.03', '1.2.3')); |
| 226 | expect(result).toBeInstanceOf(CompareSemverError); |
| 227 | expect(result.message).toContain('Failed to compare versions: 01.02.03 vs 1.2.3'); |
| 228 | expect(result.cause.message).toContain('Invalid Version: 01.02.03'); |
| 229 | }) |
| 230 | ); |
| 231 | |
| 232 | it.effect('should handle minimal versions', () => |
| 233 | Effect.gen(function* () { |
| 234 | const result = yield* semverComparator('0.0.1', '0.0.0'); |
| 235 | expect(result).toBe(1); |
| 236 | }) |
| 237 | ); |
| 238 | |
| 239 | it.effect('should handle large version numbers', () => |
| 240 | Effect.gen(function* () { |
| 241 | const result = yield* semverComparator('999.999.999', '1000.0.0'); |
| 242 | expect(result).toBe(-1); |
| 243 | }) |
| 244 | ); |
| 245 | }); |
| 246 | |
| 247 | describe('Real-world Version Examples', () => { |
| 248 | it.effect('should compare Node.js-style versions', () => |
| 249 | Effect.gen(function* () { |
| 250 | const result = yield* semverComparator('v18.16.0', 'v20.0.0'); |
| 251 | expect(result).toBe(-1); |
| 252 | }) |
| 253 | ); |
| 254 | |
| 255 | it.effect('should compare npm package versions', () => |
| 256 | Effect.gen(function* () { |
| 257 | const result = yield* semverComparator('3.2.1', '3.10.0'); |
| 258 | expect(result).toBe(-1); |
| 259 | }) |
| 260 | ); |
| 261 | |
| 262 | it.effect('should compare development versions', () => |
| 263 | Effect.gen(function* () { |
| 264 | const result = yield* semverComparator('2.0.0-dev.20240101', '2.0.0-dev.20240102'); |
| 265 | expect(result).toBe(-1); |
| 266 | }) |
| 267 | ); |
| 268 | }); |
| 269 | |
| 270 | describe('Array.sort Compatibility', () => { |
| 271 | it.effect('should work as Array.sort comparator for ascending order', () => |
| 272 | Effect.gen(function* () { |
| 273 | const pairs = [ |
| 274 | ['2.0.0', '1.0.0'], |
| 275 | ['2.0.0', '3.0.0'], |
| 276 | ['1.0.0', '3.0.0'], |
| 277 | ] as const; |
| 278 | |
| 279 | // Since we can't actually use the Effect in Array.sort, verify each |
| 280 | // pairwise result carries the polarity an ascending sort relies on |
| 281 | const results = yield* Effect.forEach(pairs, ([left, right]) => |
| 282 | semverComparator(left, right) |
| 283 | ); |
| 284 | |
| 285 | expect(results).toEqual([1, -1, -1]); |
| 286 | }) |
| 287 | ); |
| 288 | }); |
| 289 | |
| 290 | describe('Consistent Comparison Results', () => { |
| 291 | it.effect('should be reflexive (a == a)', () => |
| 292 | Effect.gen(function* () { |
| 293 | const result = yield* semverComparator('1.5.0', '1.5.0'); |
| 294 | expect(result).toBe(0); |
| 295 | }) |
| 296 | ); |
| 297 | |
| 298 | it.effect('should be antisymmetric (if a > b then b < a)', () => |
| 299 | Effect.gen(function* () { |
| 300 | const result1 = yield* semverComparator('2.0.0', '1.0.0'); |
| 301 | const result2 = yield* semverComparator('1.0.0', '2.0.0'); |
| 302 | |
| 303 | expect(result1).toBe(1); |
| 304 | expect(result2).toBe(-1); |
| 305 | expect(result1).toBe(-result2); |
| 306 | }) |
| 307 | ); |
| 308 | |
| 309 | it.effect('should be transitive (if a > b and b > c then a > c)', () => |
| 310 | Effect.gen(function* () { |
| 311 | const result1 = yield* semverComparator('3.0.0', '2.0.0'); // Should be 1 |
| 312 | const result2 = yield* semverComparator('2.0.0', '1.0.0'); // Should be 1 |
| 313 | const result3 = yield* semverComparator('3.0.0', '1.0.0'); // Should be 1 |
| 314 | |
| 315 | expect(result1).toBe(1); |
| 316 | expect(result2).toBe(1); |
| 317 | expect(result3).toBe(1); |
| 318 | }) |
| 319 | ); |
| 320 | }); |
| 321 | |
| 322 | describe('Invalid Version Handling', () => { |
| 323 | // Note: These tests check how semver.compare handles invalid versions |
| 324 | // The behavior depends on the semver library implementation |
| 325 | |
| 326 | it.effect('should reject empty strings', () => |
| 327 | Effect.gen(function* () { |
| 328 | const result = yield* Effect.flip(semverComparator('', '1.0.0')); |
| 329 | expect(result).toBeInstanceOf(CompareSemverError); |
| 330 | expect(result.message).toContain('Failed to compare versions'); |
| 331 | expect(result.cause.message).toContain('Invalid Version'); |
| 332 | }) |
| 333 | ); |
| 334 | |
| 335 | it.effect('should reject invalid version formats', () => |
| 336 | Effect.gen(function* () { |
| 337 | const result = yield* Effect.flip(semverComparator('not.a.version', '1.0.0')); |
| 338 | expect(result).toBeInstanceOf(CompareSemverError); |
| 339 | expect(result.message).toContain('Failed to compare versions: not.a.version vs 1.0.0'); |
| 340 | expect(result.cause.message).toContain('Invalid Version: not.a.version'); |
| 341 | }) |
| 342 | ); |
| 343 | |
| 344 | it.effect('should reject null-like strings', () => |
| 345 | Effect.gen(function* () { |
| 346 | const result = yield* Effect.flip(semverComparator('null', 'undefined')); |
| 347 | expect(result).toBeInstanceOf(CompareSemverError); |
| 348 | expect(result.message).toContain('Failed to compare versions: null vs undefined'); |
| 349 | expect(result.cause.message).toContain('Invalid Version: null'); |
| 350 | }) |
| 351 | ); |
| 352 | }); |
| 353 | }); |
| 354 | }); |