Compare commits
	
		
			741 Commits
		
	
	
		
			v3.2.17
			...
			b6d2d459c5
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| b6d2d459c5 | |||
| c2d5dd4ffd | |||
| 
						 | 
					fa53fac085 | ||
| 8c060df5e3 | |||
| e1f8c62685 | |||
| 562b1ab9b7 | |||
| 
						 | 
					f3c877a37b | ||
| 0999b2ad78 | |||
| a365513177 | |||
| 
						 | 
					d1e3f3cab2 | ||
| ec94a09417 | |||
| 1728b88e06 | |||
| d3c31da9db | |||
| 59095681be | |||
| f11ceba225 | |||
| ffa01de78f | |||
| 816abc2bbc | |||
| f3f2a9b737 | |||
| 3f82cb3ba4 | |||
| 
						 | 
					306b7a3962 | ||
| a8eda9d58d | |||
| 7e4477dcb4 | |||
| 
						 | 
					d846044fc6 | ||
| 29d956e74e | |||
| fcc4faff8a | |||
| 5df8f83f45 | |||
| 
						 | 
					27fa6e9173 | ||
| bd55a35dc3 | |||
| 653bd386cc | |||
| 
						 | 
					558c6f4d7c | ||
| d7dd6fbeb2 | |||
| a00cf2c8d9 | |||
| 
						 | 
					a3e8ab2492 | ||
| 06da500ef4 | |||
| 277f04ba19 | |||
| 
						 | 
					470263ff5f | ||
| b8232e02be | |||
| 
						 | 
					f8c5e10c1d | ||
| 397e71f815 | |||
| 74e31d99f6 | |||
| f39de15d93 | |||
| d291102877 | |||
| 37ffbb18d8 | |||
| 9a85dead86 | |||
| a489aab1c3 | |||
| d160664ef1 | |||
| fa868edcaa | |||
| 
						 | 
					6ed0b0e090 | ||
| 533b265d19 | |||
| 1ace2631a4 | |||
| 3dd5ca68d1 | |||
| 66ccd6021f | |||
| e5346f7e4f | |||
| 
						 | 
					daf19f031a | ||
| 5989fd54ca | |||
| ed30c26324 | |||
| 0f8f93d09a | |||
| 
						 | 
					f460e2f8dd | ||
| 70d6a79274 | |||
| 664b1586af | |||
| 8d747c64a8 | |||
| 94beb5ed3b | |||
| 98981ba86c | |||
| 1013f50d0e | |||
| 0b190997b1 | |||
| 69a44eb190 | |||
| 0476028f69 | |||
| 330d8b149a | |||
| 19b04fe070 | |||
| 4cd55875c6 | |||
| a7896cc728 | |||
| ff991bf49c | |||
| 5a6551b703 | |||
| 9406a33d60 | |||
| 8f185abd9d | |||
| 86492e0644 | |||
| b21972964a | |||
| f5ee065d09 | |||
| 8cb02f2b08 | |||
| bc926cd6bd | |||
| 356abfd818 | |||
| 18444d3f98 | |||
| d5f07922e8 | |||
| 675e717410 | |||
| 7b6aea235a | |||
| 2cb7200467 | |||
| f430f97a97 | |||
| 0060c4377a | |||
| e46579fe9a | |||
| ca52973194 | |||
| 5bb33c7e1d | |||
| b71fc25328 | |||
| 9345dd075a | |||
| 1c1b9c0a28 | |||
| 2969494c5a | |||
| cbd3fa38ba | |||
| 569a36383d | |||
| 90bed77526 | |||
| ba4478a5e0 | |||
| 6dc76cdfea | |||
| e266683d96 | |||
| 2b62ad04f2 | |||
| 275b0a64e5 | |||
| 38c5fe8b5a | |||
| b6a0e4d983 | |||
| d9b822deff | |||
| 0e66688f8f | |||
| 9213fd212f | |||
| aa360dcf51 | |||
| 2df259b5b8 | |||
| 15e9310368 | |||
| 
						 | 
					16d8cf3434 | ||
| 9704ef2e5e | |||
| 94e8f90f00 | |||
| 34d1587881 | |||
| bf4143cde5 | |||
| 36b7b9f5fb | |||
| ae97023092 | |||
| 115ca6a018 | |||
| 89cf4ef8af | |||
| 2a6ce6d4da | |||
| ad19fe2b90 | |||
| 49055a28ea | |||
| d1c6e121c1 | |||
| 7cd7fb0c0a | |||
| 77eb5b5264 | |||
| 929e46c087 | |||
| 1fb5673d27 | |||
| 3bbb0cbc72 | |||
| 71fe0df73f | |||
| f1b8ecbdb3 | |||
| fd2b2762e9 | |||
| 82d269cfb4 | |||
| 6641463eed | |||
| faf2454f0a | |||
| de9e4d73f5 | |||
| 4ae7277140 | |||
| a98618ed5b | |||
| 3aaf1182cb | |||
| eb1482d789 | |||
| a305f7553f | |||
| 
						 | 
					d9b2f2a45d | ||
| 3ace7657dc | |||
| 53b40617e2 | |||
| 1a9236caad | |||
| 6c68d39081 | |||
| 35e62fbeb0 | |||
| 00b3ceb468 | |||
| 7dc8f088c9 | |||
| c65afcea1b | |||
| 3eebfb5b11 | |||
| fa1427014c | |||
| 62074965ee | |||
| 9c8fbb2202 | |||
| 7c0a5f5e2a | |||
| b08f5321b0 | |||
| cc0f24e012 | |||
| 307a08f50c | |||
| edc93e8c37 | |||
| 391813c260 | |||
| 1a1459dd0e | |||
| 4e99680c30 | |||
| 92a3a547b8 | |||
| 849c462037 | |||
| 54a55c83e2 | |||
| 781dee03db | |||
| 26dd2eb405 | |||
| 3a21069b86 | |||
| add3ce478c | |||
| 
						 | 
					c3de003e4a | ||
| 7b7cf18a65 | |||
| 1bcf71c189 | |||
| c320d8e518 | |||
| b5f8316b57 | |||
| d7ddd912a8 | |||
| c020d90cb4 | |||
| db47b62159 | |||
| 8254456c8b | |||
| c2808679c3 | |||
| f418235c16 | |||
| 67ba7b3753 | |||
| e48d7cadf9 | |||
| c906186011 | |||
| dc0ff91b83 | |||
| e739c2d438 | |||
| bf4a036652 | |||
| f83a29eb67 | |||
| aef7f53d88 | |||
| 02c8e4fb7f | |||
| f5693bd940 | |||
| 701afb7bea | |||
| 019b407e74 | |||
| f29a346434 | |||
| 27db1876c0 | |||
| f66ac9736b | |||
| ed7972a1fa | |||
| 2cc004b01c | |||
| df951e5daf | |||
| 5bec0cef03 | |||
| 34940b68d7 | |||
| 1c57127128 | |||
| a4dd1a494c | |||
| 60e5e42167 | |||
| b519b61fff | |||
| f62b26eda3 | |||
| 13eda451da | |||
| 89cad06121 | |||
| 0bebf3d59f | |||
| 01e05e8df6 | |||
| 2b69a4f51c | |||
| 4af2b077dd | |||
| de4418189d | |||
| 2c44550897 | |||
| 99b8a3c950 | |||
| 4c7e1607d4 | |||
| 897be419b4 | |||
| 81b9a4341f | |||
| d3bb2f7236 | |||
| 97fd62cb21 | |||
| 3cd8bc33d6 | |||
| f6f67af8d0 | |||
| 2d5acaca2f | |||
| 0674df3d9f | |||
| 2c282825ce | |||
| e87ff942bb | |||
| 0459ea0613 | |||
| d44a75d074 | |||
| 
						 | 
					ccf92eb84d | ||
| 6baf1f2744 | |||
| 8e2eafde9c | |||
| c2b97b0f20 | |||
| 1db017d966 | |||
| debf8cb03d | |||
| 1dc9c1891f | |||
| 930859a537 | |||
| 3141f1ed8b | |||
| 47943cfb05 | |||
| ed4e9d54b1 | |||
| b4b8583594 | |||
| fb43e8c58c | |||
| 8863c10ef4 | |||
| 8058095bcc | |||
| 092f5d96b1 | |||
| 84552513f7 | |||
| 80a2db264e | |||
| 0be09c8b3e | |||
| 047f479e1b | |||
| 8f757c953e | |||
| 5f1c673a24 | |||
| 6794ea9871 | |||
| 089e7b6812 | |||
| 1c703f0f0c | |||
| d167c8c67c | |||
| df4f96a2d8 | |||
| fac3b20bd4 | |||
| 7c6bd98498 | |||
| 23e1174f25 | |||
| 52bed214cf | |||
| 64c4f5f47e | |||
| 036c612137 | |||
| ca80e3ecf2 | |||
| 18e7bb41ca | |||
| 8e72fb1c35 | |||
| 17f21a03f4 | |||
| a076d43a26 | |||
| de6efaee0b | |||
| 9e0e657003 | |||
| be5f9ab77f | |||
| 144dca0cae | |||
| 75173560e3 | |||
| 9b3bccd1f1 | |||
| ce125b77c1 | |||
| 2ee8d4ed46 | |||
| f58781d076 | |||
| e1af4aa3a4 | |||
| 1d5e795443 | |||
| a3a434d923 | |||
| bcc06054f1 | |||
| 270d26f1ae | |||
| 646212cc08 | |||
| 00c2c749db | |||
| 2dbada0e94 | |||
| 7b8f4410fb | |||
| 45ebef5544 | |||
| cf4cac0733 | |||
| 50d60b5825 | |||
| 46ef491764 | |||
| a51b8b8102 | |||
| 15aac48f1e | |||
| 078069b2d7 | |||
| 258812304a | |||
| da5d50db5b | |||
| 384e4d113d | |||
| dfd1da7f0d | |||
| 8e5015e580 | |||
| bd0c309b71 | |||
| b4f0c3e29a | |||
| 8fddaa0455 | |||
| 2710c269a8 | |||
| 70ea93e466 | |||
| a87d0ab1c1 | |||
| 2e5e102719 | |||
| 36e492314d | |||
| 0c78873277 | |||
| 7f57dc09d3 | |||
| 447206d256 | |||
| 33a7feb970 | |||
| 3950f2ed86 | |||
| 68c1048a7d | |||
| bff40bd317 | |||
| 2878d0a4ea | |||
| 3138a9fded | |||
| 742b99636a | |||
| 34387f129d | |||
| 47075acb06 | |||
| 09cb998ba4 | |||
| b9dbfb1cfc | |||
| 56efccc4cf | |||
| ce9f896287 | |||
| 83d87a40e4 | |||
| 75fd1e43b9 | |||
| 395a3eed3d | |||
| 3ba8cb7f9e | |||
| b07806b9a1 | |||
| 0f583218d4 | |||
| f4d0237785 | |||
| 0f343dad0b | |||
| 7c29afba0b | |||
| 8159b9d233 | |||
| 45cdac5c29 | |||
| 98db0dc8bc | |||
| 453d2232bd | |||
| 9b387312da | |||
| 84024f7713 | |||
| 5a554f9f0c | |||
| 9c33cbc8e2 | |||
| 848fe1c0d4 | |||
| 6cbf23fec5 | |||
| 7462b0b53c | |||
| cb743cee3f | |||
| d18952951c | |||
| 
						 | 
					f6b7f1b4bc | ||
| 
						 | 
					33fa702104 | ||
| 4debc392d1 | |||
| 7137d99102 | |||
| f76b3171d9 | |||
| db3fc42204 | |||
| f59023d741 | |||
| 6f17fd891a | |||
| fd93308e8e | |||
| 2aaa0a74d8 | |||
| ccbf23688b | |||
| 3bd6db79cb | |||
| 9347bb0651 | |||
| 0d63723ed3 | |||
| a7f84e0baa | |||
| c209892ce8 | |||
| 421842315f | |||
| 25350a6531 | |||
| 5e47cc7e8c | |||
| 1687b98b11 | |||
| a81649d2a2 | |||
| b48faa3b2b | |||
| 0be584ef0d | |||
| 26a2d18766 | |||
| 25a796fe4f | |||
| d23de14769 | |||
| 2fb108519c | |||
| c7ce238da3 | |||
| 
						 | 
					67aa79f18a | ||
| e6c3d734a3 | |||
| 1374e27531 | |||
| 1060f6a4c3 | |||
| 7d72ab05c6 | |||
| 42864ff1c6 | |||
| 49978b75c0 | |||
| 
						 | 
					20770b6e30 | ||
| b38c6106b2 | |||
| 
						 | 
					138c4a0888 | ||
| 
						 | 
					22f66fc258 | ||
| 18fafbbbab | |||
| 59c08c1d9a | |||
| 5fbb1a923e | |||
| 396387d1e8 | |||
| 
						 | 
					4c2f12a419 | ||
| b2abb86971 | |||
| e546eef96c | |||
| 91701e7a45 | |||
| 817bf1f4d0 | |||
| 4120f79b55 | |||
| d659db69ff | |||
| 416bb313fc | |||
| ec43cfea6b | |||
| 
						 | 
					60194fb42e | ||
| 
						 | 
					945d9d16a5 | ||
| 1c0e5e1a85 | |||
| 33591e0bc9 | |||
| 
						 | 
					75cbaf2612 | ||
| f4aee3414b | |||
| 9f7b61eb17 | |||
| 5953b5aae6 | |||
| 4a8f490e0c | |||
| eb8c1332f0 | |||
| c1c27b6d1d | |||
| 
						 | 
					bb22b203cc | ||
| 
						 | 
					4df2f3a5a1 | ||
| b8ad19a5a2 | |||
| 
						 | 
					d32a97c846 | ||
| cfe0473ae0 | |||
| c26ad51e25 | |||
| aefc398b71 | |||
| 9af23e3e74 | |||
| 4ab7f19ef0 | |||
| d26e9d642b | |||
| f9ecb9b056 | |||
| dbfcfcd288 | |||
| 8b6bdb857b | |||
| 1181e9dc5e | |||
| 6ac7b53d75 | |||
| 80d342a72a | |||
| 8ff312e71d | |||
| 20e40ccdfd | |||
| d4efbb9b22 | |||
| b433cbcbb6 | |||
| dae3c1170b | |||
| a10dd3d08a | |||
| b075230ae5 | |||
| 289aadb28e | |||
| 9640cdae1a | |||
| 
						 | 
					fb35e73731 | ||
| f416cb3e0e | |||
| 57d06d5d27 | |||
| 0628408c27 | |||
| 206cd8c3c9 | |||
| 
						 | 
					b38db00ee5 | ||
| 
						 | 
					0ca39a1477 | ||
| d9be99cfde | |||
| b37c6006c4 | |||
| 12f188e3ad | |||
| 08aaf14a79 | |||
| 2ce1e94596 | |||
| c5aeaf6db7 | |||
| 1db505decd | |||
| 8b1a579c9d | |||
| 11b614f2df | |||
| fb4d747197 | |||
| 00439e23f3 | |||
| 955953b519 | |||
| aa2b5ddaad | |||
| 46da092899 | |||
| b871f64ba6 | |||
| 74db004f51 | |||
| f93ba9d977 | |||
| c7da7d5bc8 | |||
| ed27647be5 | |||
| 
						 | 
					db3b67267e | ||
| 9ee9cc2a4a | |||
| 0b41b4f9c5 | |||
| 8d14753931 | |||
| 93fc17bad3 | |||
| 5a1cd12d3d | |||
| 5c00e6763f | |||
| 497b82ac6c | |||
| a8c6690af7 | |||
| 98d2264c2a | |||
| 63641b9840 | |||
| 2b28057918 | |||
| 25c551411b | |||
| 35162a82a4 | |||
| 0ce0855b6a | |||
| 226ec43ecf | |||
| 575af66ddc | |||
| 
						 | 
					afb9e8c240 | ||
| c10f29ee74 | |||
| 03410c4ab1 | |||
| 3805d0f067 | |||
| 680ac11ef9 | |||
| 35ab6ae84e | |||
| c6c2b0884e | |||
| 297a80da84 | |||
| 2d292db7bd | |||
| 54c4287fab | |||
| 9c074e5741 | |||
| 290975eaf5 | |||
| c64218d52c | |||
| 
						 | 
					46c266a4a9 | ||
| 5527b16cd8 | |||
| 4904cad8ef | |||
| 74633f4290 | |||
| 
						 | 
					c8ad4d772b | ||
| 91bd0f7efe | |||
| 00dc7e1bb5 | |||
| 5a5165a003 | |||
| 382e3d554b | |||
| 05a0c97fc6 | |||
| 
						 | 
					5e06ae1a42 | ||
| 
						 | 
					7ac4ad4efa | ||
| 
						 | 
					01348bd9b2 | ||
| 2287c65118 | |||
| b34bc7ffff | |||
| 
						 | 
					2a0bf03d0a | ||
| 89114c291c | |||
| 
						 | 
					b4b4320fac | ||
| 7b0d69115c | |||
| f054beb6e8 | |||
| 9fb346594e | |||
| 
						 | 
					cbf6fbd780 | ||
| 
						 | 
					0392bff282 | ||
| 
						 | 
					75b1fe5dc6 | ||
| 1f232ffba8 | |||
| 
						 | 
					7f43b64fc2 | ||
| d0d04a840a | |||
| 1dda3f0dcc | |||
| 1abf5e7647 | |||
| f06610c9c2 | |||
| df8560bb6f | |||
| 0257eae936 | |||
| 58f03d05e7 | |||
| 60340a749b | |||
| 56b0df5b7a | |||
| 
						 | 
					bb59d5a2fd | ||
| 67d5dc7e28 | |||
| 797c0f822d | |||
| 8546140e22 | |||
| 92b125c1ce | |||
| 8f7eebc24f | |||
| b0def96d14 | |||
| 927ca879b2 | |||
| 00450c9cc7 | |||
| 534bce2d20 | |||
| 53949be0cc | |||
| d8fe2ff8b4 | |||
| 53b5ee2c6f | |||
| dfd85cd871 | |||
| 52182261af | |||
| 1f3834e187 | |||
| 0354873c3a | |||
| 8e5e2167cd | |||
| c26a7db47c | |||
| 74765b4c5f | |||
| 8bd7323af1 | |||
| 
						 | 
					899dc8b3bc | ||
| 6e6c31b5dd | |||
| 94929878fe | |||
| 8ce469a09e | |||
| 88788776d2 | |||
| e143e2b547 | |||
| a36f99e30b | |||
| 326ee53333 | |||
| 1244c5bb4d | |||
| 4ccc8a9c85 | |||
| 8a2e84d489 | |||
| d29363b78d | |||
| 734f751055 | |||
| 55d8a9ee20 | |||
| 07c93042ba | |||
| b9bbfdf159 | |||
| fbad257acc | |||
| 1829febb6e | |||
| 7838fa62a8 | |||
| 332803d8de | |||
| 11c868d476 | |||
| 38d6e482d7 | |||
| 07d4085201 | |||
| 45f30c0be3 | |||
| bcaea675a7 | |||
| 3087ba1d73 | |||
| 3f5b19497c | |||
| 37d937d7ae | |||
| 7d68f2396e | |||
| 0854a7ea72 | |||
| 5eb0e56373 | |||
| 6af837fd25 | |||
| ada59119cc | |||
| 8abc913b28 | |||
| 3247d144a8 | |||
| 7b2e3cc8aa | |||
| 8688179acd | |||
| 3e40bac5f4 | |||
| e3fee6f8a6 | |||
| 15c020fac5 | |||
| 3bc046e5d4 | |||
| 542f36cfa5 | |||
| 8237e6a08e | |||
| ecb60e4dc5 | |||
| a1999ff81c | |||
| d0f2bc8346 | |||
| 
						 | 
					dd29bf457e | ||
| d062c248e3 | |||
| 875f66d36e | |||
| 818a0e6356 | |||
| 56e02ec463 | |||
| 6ca851401d | |||
| bd8216b397 | |||
| 2b13b3f128 | |||
| 9957380b6d | |||
| e10f8c0fa0 | |||
| 45252fe4a6 | |||
| faad082efe | |||
| 8ab35cbd9b | |||
| ad58ab6943 | |||
| 0e97049e1d | |||
| edb0bbf9cf | |||
| 
						 | 
					1b01bd22a6 | ||
| 2fbaa26f0f | |||
| 35d3e4b332 | |||
| 
						 | 
					e98a93d530 | ||
| e3545532e8 | |||
| 09653c2fb2 | |||
| 70adfeab0d | |||
| a45b672c98 | |||
| 4509323cae | |||
| b3f4c670d5 | |||
| 778dd449e2 | |||
| 1d16983b67 | |||
| f386bffd37 | |||
| 772bde7938 | |||
| ea16f5f825 | |||
| c2f34df493 | |||
| efe215cd60 | |||
| b4f332bf0d | |||
| f47fbb1030 | |||
| 1e8e57a708 | |||
| 
						 | 
					5d0959b0a1 | ||
| fa8fb3aed7 | |||
| cfd2d53a79 | |||
| d306f77ffc | |||
| e5b0a7e20d | |||
| 9a5b158b4d | |||
| af8d81f3c6 | |||
| 5c9b3dae33 | |||
| 9f3957d101 | |||
| 8fd8bdcb39 | |||
| 80e3d239ab | |||
| 419cd486cf | |||
| e64269b2a8 | |||
| d18429e024 | |||
| 675e121049 | |||
| d357fb1e0d | |||
| e4673bcc50 | |||
| a839f75a2f | |||
| a7e6d61b95 | |||
| 650d167313 | |||
| c6ba2a91e6 | |||
| 7ece08896f | |||
| 
						 | 
					57f6f23294 | ||
| 09e6fa2fed | |||
| 10a09a5c6f | |||
| b4e5d9462a | |||
| 96aa0b6906 | |||
| f54658830d | |||
| 1e43122660 | |||
| 42800fa247 | |||
| 5b9c810653 | |||
| c3def24bf4 | |||
| 0d1ef31764 | |||
| d49afa230f | |||
| e545eb4e13 | |||
| f28b107372 | |||
| c592fabe2a | |||
| eb107020c7 | |||
| bd4d4c363e | |||
| 2a548634fd | |||
| 598dddc476 | |||
| 887b48f1e7 | |||
| 6e55d07636 | |||
| 919520219c | |||
| 60a5e737f8 | |||
| 34f0b209cc | |||
| ba8e1889fe | |||
| dae5c57a60 | |||
| ea590d57df | |||
| 
						 | 
					9aa6969836 | ||
| 
						 | 
					c00c705c24 | ||
| 
						 | 
					0239f795d8 | ||
| 
						 | 
					e69b43881d | ||
| 3a48a613fe | |||
| 86626c5922 | |||
| ee11f39a2f | |||
| 3bdfdd8fd2 | |||
| 6dfdff7fd8 | |||
| 00a4785df3 | |||
| 
						 | 
					bae3b0ef94 | ||
| 
						 | 
					89b0565062 | ||
| 1f8b0aeb61 | |||
| 
						 | 
					5b6f849e0a | ||
| 
						 | 
					3b416fffde | ||
| 3a60103aed | |||
| 41837a67f8 | |||
| 852f19598d | |||
| 6537b35773 | |||
| b733f1316f | |||
| 
						 | 
					840af5574c | ||
| 
						 | 
					56e5b7001c | ||
| 
						 | 
					11dc6fd752 | ||
| a2695d8699 | |||
| 618421de05 | |||
| 
						 | 
					30baaabd9f | ||
| df5bce1191 | |||
| 
						 | 
					089d0fe4df | ||
| a06f535303 | |||
| 
						 | 
					eba586a329 | ||
| 
						 | 
					d74a8645e8 | ||
| 
						 | 
					5a00786192 | ||
| 
						 | 
					b3e9941634 | ||
| 
						 | 
					a5a5904302 | ||
| 
						 | 
					a59832e57e | ||
| 0e42033e7f | |||
| 52d8255974 | |||
| 9830cb48a9 | |||
| 92d7ab2105 | |||
| d2935ef399 | |||
| ce4c96ae0a | |||
| 
						 | 
					14026d15be | ||
| 
						 | 
					2df0c7643e | ||
| e13c2c48fd | |||
| 8db55d2e55 | |||
| ed61cad961 | |||
| 040fc4548f | |||
| 6189a1b980 | |||
| eb2a450a7b | |||
| 
						 | 
					d2a30a5da1 | ||
| 65889c66f6 | |||
| dcdf133d5b | |||
| 8742b55305 | |||
| 4a64ee72f7 | |||
| 881d7afeea | |||
| 8c95448535 | |||
| c1dc041d8c | |||
| 
						 | 
					25be0ac0f0 | ||
| 
						 | 
					86f73cac4e | ||
| 485eda6ce9 | |||
| dbbdb24631 | |||
| 723ceb4f32 | |||
| bac9869bb3 | |||
| 610427445f | |||
| 
						 | 
					c84a66c713 | ||
| 00eaae717b | |||
| a102e95433 | |||
| 39f66cc86c | |||
| bbbcb22565 | 
							
								
								
									
										18
									
								
								.gitea/ISSUE_TEMPLATE/bug_report.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										18
									
								
								.gitea/ISSUE_TEMPLATE/bug_report.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,18 @@
 | 
			
		||||
---
 | 
			
		||||
name: Bug report
 | 
			
		||||
about: For reporting bugs in micro
 | 
			
		||||
title: "[BUG]"
 | 
			
		||||
labels: ''
 | 
			
		||||
assignees: ''
 | 
			
		||||
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
**Describe the bug**
 | 
			
		||||
 | 
			
		||||
1. What are you trying to do?
 | 
			
		||||
2. What did you expect to happen?
 | 
			
		||||
3. What happens instead?
 | 
			
		||||
 | 
			
		||||
**How to reproduce the bug:**
 | 
			
		||||
 | 
			
		||||
If possible, please include a minimal code snippet here.
 | 
			
		||||
							
								
								
									
										17
									
								
								.gitea/ISSUE_TEMPLATE/feature-request---enhancement.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										17
									
								
								.gitea/ISSUE_TEMPLATE/feature-request---enhancement.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,17 @@
 | 
			
		||||
---
 | 
			
		||||
name: Feature request / Enhancement
 | 
			
		||||
about: If you have a need not served by micro
 | 
			
		||||
title: "[FEATURE]"
 | 
			
		||||
labels: ''
 | 
			
		||||
assignees: ''
 | 
			
		||||
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
**Is your feature request related to a problem? Please describe.**
 | 
			
		||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
 | 
			
		||||
 | 
			
		||||
**Describe the solution you'd like**
 | 
			
		||||
A clear and concise description of what you want to happen.
 | 
			
		||||
 | 
			
		||||
**Additional context**
 | 
			
		||||
Add any other context or screenshots about the feature request here.
 | 
			
		||||
							
								
								
									
										8
									
								
								.gitea/ISSUE_TEMPLATE/question.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										8
									
								
								.gitea/ISSUE_TEMPLATE/question.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,8 @@
 | 
			
		||||
---
 | 
			
		||||
name: Question
 | 
			
		||||
about: Ask a question about micro
 | 
			
		||||
title: ''
 | 
			
		||||
labels: ''
 | 
			
		||||
assignees: ''
 | 
			
		||||
 | 
			
		||||
---
 | 
			
		||||
							
								
								
									
										28
									
								
								.gitea/autoapprove.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										28
									
								
								.gitea/autoapprove.yml
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,28 @@
 | 
			
		||||
name: "autoapprove"
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  pull_request_target:
 | 
			
		||||
    types: [assigned, opened, synchronize, reopened]
 | 
			
		||||
  workflow_run:
 | 
			
		||||
    workflows: ["prbuild"]
 | 
			
		||||
    types:
 | 
			
		||||
      - completed
 | 
			
		||||
 | 
			
		||||
permissions:
 | 
			
		||||
  pull-requests: write
 | 
			
		||||
  contents: write
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  autoapprove:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: approve
 | 
			
		||||
        run: [ "curl -o tea https://dl.gitea.com/tea/main/tea-main-linux-amd64",
 | 
			
		||||
               "chmod +x ./tea",
 | 
			
		||||
               "./tea login add --name unistack --token ${{ secrets.GITHUB_TOKEN }} --url https://git.unistack.org",
 | 
			
		||||
               "./tea pr --repo ${{ github.event.repository.name }}"
 | 
			
		||||
        ]
 | 
			
		||||
        if: github.actor == 'vtolstov'
 | 
			
		||||
        id: approve
 | 
			
		||||
        with:
 | 
			
		||||
          github-token: ${{ secrets.GITHUB_TOKEN }}
 | 
			
		||||
							
								
								
									
										51
									
								
								.gitea/workflows/job_coverage.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										51
									
								
								.gitea/workflows/job_coverage.yml
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,51 @@
 | 
			
		||||
name: coverage
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  push:
 | 
			
		||||
    branches: [ main, v3, v4 ]
 | 
			
		||||
  pull_request:
 | 
			
		||||
    branches: [ main, v3, v4 ]
 | 
			
		||||
  # Allows you to run this workflow manually from the Actions tab
 | 
			
		||||
  workflow_dispatch:
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
 | 
			
		||||
  build:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
    - name: checkout code
 | 
			
		||||
      uses: actions/checkout@v4
 | 
			
		||||
      with:
 | 
			
		||||
        filter: 'blob:none'
 | 
			
		||||
 | 
			
		||||
    - name: setup go
 | 
			
		||||
      uses: actions/setup-go@v5
 | 
			
		||||
      with:
 | 
			
		||||
        cache-dependency-path: "**/*.sum"
 | 
			
		||||
        go-version: 'stable' 
 | 
			
		||||
 | 
			
		||||
    - name: test coverage
 | 
			
		||||
      run: |
 | 
			
		||||
        go test -v -cover ./... -covermode=count -coverprofile coverage.out -coverpkg ./...
 | 
			
		||||
        go tool cover -func coverage.out -o coverage.out
 | 
			
		||||
 | 
			
		||||
    - name: coverage badge
 | 
			
		||||
      uses: tj-actions/coverage-badge-go@v2
 | 
			
		||||
      with:
 | 
			
		||||
        green: 80
 | 
			
		||||
        filename: coverage.out
 | 
			
		||||
 | 
			
		||||
    - uses: stefanzweifel/git-auto-commit-action@v4
 | 
			
		||||
      name: autocommit
 | 
			
		||||
      with:
 | 
			
		||||
        commit_message: Apply Code Coverage Badge
 | 
			
		||||
        skip_fetch: true
 | 
			
		||||
        skip_checkout: true
 | 
			
		||||
        file_pattern: ./README.md
 | 
			
		||||
 | 
			
		||||
    - name: push
 | 
			
		||||
      if: steps.auto-commit-action.outputs.changes_detected == 'true'
 | 
			
		||||
      uses: ad-m/github-push-action@master
 | 
			
		||||
      with:
 | 
			
		||||
        github_token: ${{ github.token }}
 | 
			
		||||
        branch: ${{ github.ref }}
 | 
			
		||||
							
								
								
									
										29
									
								
								.gitea/workflows/job_lint.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										29
									
								
								.gitea/workflows/job_lint.yml
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,29 @@
 | 
			
		||||
name: lint
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  pull_request:
 | 
			
		||||
    types: [opened, reopened, synchronize]
 | 
			
		||||
    branches:
 | 
			
		||||
    - master
 | 
			
		||||
    - v3
 | 
			
		||||
    - v4
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  lint:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
    - name: checkout code
 | 
			
		||||
      uses: actions/checkout@v4
 | 
			
		||||
      with:
 | 
			
		||||
        filter: 'blob:none'
 | 
			
		||||
    - name: setup go
 | 
			
		||||
      uses: actions/setup-go@v5
 | 
			
		||||
      with:
 | 
			
		||||
        cache-dependency-path: "**/*.sum"
 | 
			
		||||
        go-version: 'stable' 
 | 
			
		||||
    - name: setup deps
 | 
			
		||||
      run: go get -v ./...
 | 
			
		||||
    - name: run lint
 | 
			
		||||
      uses: https://github.com/golangci/golangci-lint-action@v6
 | 
			
		||||
      with:
 | 
			
		||||
        version: 'latest'
 | 
			
		||||
							
								
								
									
										34
									
								
								.gitea/workflows/job_test.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										34
									
								
								.gitea/workflows/job_test.yml
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,34 @@
 | 
			
		||||
name: test
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  pull_request:
 | 
			
		||||
    types: [opened, reopened, synchronize]
 | 
			
		||||
    branches:
 | 
			
		||||
    - master
 | 
			
		||||
    - v3
 | 
			
		||||
    - v4
 | 
			
		||||
  push:
 | 
			
		||||
    branches:
 | 
			
		||||
    - master
 | 
			
		||||
    - v3
 | 
			
		||||
    - v4
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  test:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
    - name: checkout code
 | 
			
		||||
      uses: actions/checkout@v4
 | 
			
		||||
      with:
 | 
			
		||||
        filter: 'blob:none'
 | 
			
		||||
    - name: setup go
 | 
			
		||||
      uses: actions/setup-go@v5
 | 
			
		||||
      with:
 | 
			
		||||
        cache-dependency-path: "**/*.sum"
 | 
			
		||||
        go-version: 'stable'
 | 
			
		||||
    - name: setup deps
 | 
			
		||||
      run: go get -v ./...
 | 
			
		||||
    - name: run test
 | 
			
		||||
      env:
 | 
			
		||||
        INTEGRATION_TESTS: yes
 | 
			
		||||
      run: go test -mod readonly -v ./...
 | 
			
		||||
							
								
								
									
										53
									
								
								.gitea/workflows/job_tests.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										53
									
								
								.gitea/workflows/job_tests.yml
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,53 @@
 | 
			
		||||
name: test
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  pull_request:
 | 
			
		||||
    types: [opened, reopened, synchronize]
 | 
			
		||||
    branches:
 | 
			
		||||
    - master
 | 
			
		||||
    - v3
 | 
			
		||||
    - v4
 | 
			
		||||
  push:
 | 
			
		||||
    branches:
 | 
			
		||||
    - master
 | 
			
		||||
    - v3
 | 
			
		||||
    - v4
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  test:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
    - name: checkout code
 | 
			
		||||
      uses: actions/checkout@v4
 | 
			
		||||
      with:
 | 
			
		||||
        filter: 'blob:none'
 | 
			
		||||
    - name: checkout tests
 | 
			
		||||
      uses: actions/checkout@v4
 | 
			
		||||
      with:
 | 
			
		||||
        ref: master
 | 
			
		||||
        filter: 'blob:none'
 | 
			
		||||
        repository: unistack-org/micro-tests
 | 
			
		||||
        path: micro-tests
 | 
			
		||||
    - name: setup go
 | 
			
		||||
      uses: actions/setup-go@v5
 | 
			
		||||
      with:
 | 
			
		||||
        cache-dependency-path: "**/*.sum"
 | 
			
		||||
        go-version: 'stable'
 | 
			
		||||
    - name: setup go work
 | 
			
		||||
      env:
 | 
			
		||||
        GOWORK: /workspace/${{ github.repository_owner }}/go.work
 | 
			
		||||
      run: |
 | 
			
		||||
        go work init
 | 
			
		||||
        go work use .
 | 
			
		||||
        go work use micro-tests
 | 
			
		||||
    - name: setup deps
 | 
			
		||||
      env:
 | 
			
		||||
        GOWORK: /workspace/${{ github.repository_owner }}/go.work
 | 
			
		||||
      run: go get -v ./...
 | 
			
		||||
    - name: run tests
 | 
			
		||||
      env:
 | 
			
		||||
        INTEGRATION_TESTS: yes
 | 
			
		||||
        GOWORK: /workspace/${{ github.repository_owner }}/go.work
 | 
			
		||||
      run: |
 | 
			
		||||
        cd micro-tests
 | 
			
		||||
        go test -mod readonly -v ./... || true
 | 
			
		||||
							
								
								
									
										9
									
								
								.github.old/PULL_REQUEST_TEMPLATE.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										9
									
								
								.github.old/PULL_REQUEST_TEMPLATE.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,9 @@
 | 
			
		||||
## Pull Request template
 | 
			
		||||
Please, go through these steps before clicking submit on this PR.
 | 
			
		||||
 | 
			
		||||
1. Give a descriptive title to your PR.
 | 
			
		||||
2. Provide a description of your changes.
 | 
			
		||||
3. Make sure you have some relevant tests.
 | 
			
		||||
4. Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if applicable).
 | 
			
		||||
 | 
			
		||||
**PLEASE REMOVE THIS TEMPLATE BEFORE SUBMITTING**
 | 
			
		||||
							
								
								
									
										26
									
								
								.github.old/dependabot.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										26
									
								
								.github.old/dependabot.yml
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,26 @@
 | 
			
		||||
# To get started with Dependabot version updates, you'll need to specify which
 | 
			
		||||
# package ecosystems to update and where the package manifests are located.
 | 
			
		||||
# Please see the documentation for all configuration options:
 | 
			
		||||
# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
 | 
			
		||||
 | 
			
		||||
version: 2
 | 
			
		||||
updates:
 | 
			
		||||
 | 
			
		||||
  # Maintain dependencies for GitHub Actions
 | 
			
		||||
  - package-ecosystem: "github-actions"
 | 
			
		||||
    directory: "/"
 | 
			
		||||
    schedule:
 | 
			
		||||
      interval: "daily"
 | 
			
		||||
    commit-message:
 | 
			
		||||
      prefix: "chore"
 | 
			
		||||
      include: "scope"
 | 
			
		||||
 | 
			
		||||
  # Maintain dependencies for Golang
 | 
			
		||||
  - package-ecosystem: "gomod"
 | 
			
		||||
    directory: "/"
 | 
			
		||||
    schedule:
 | 
			
		||||
      interval: "daily"
 | 
			
		||||
    commit-message:
 | 
			
		||||
      prefix: "chore"
 | 
			
		||||
      include: "scope"
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										24
									
								
								.github.old/workflows/autoapprove.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										24
									
								
								.github.old/workflows/autoapprove.yml
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,24 @@
 | 
			
		||||
name: "autoapprove"
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  pull_request_target:
 | 
			
		||||
    types: [assigned, opened, synchronize, reopened]
 | 
			
		||||
  workflow_run:
 | 
			
		||||
    workflows: ["prbuild"]
 | 
			
		||||
    types:
 | 
			
		||||
      - completed
 | 
			
		||||
 | 
			
		||||
permissions:
 | 
			
		||||
  pull-requests: write
 | 
			
		||||
  contents: write
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  autoapprove:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: approve
 | 
			
		||||
        uses: hmarr/auto-approve-action@v3
 | 
			
		||||
        if: github.actor == 'vtolstov' || github.actor == 'dependabot[bot]'
 | 
			
		||||
        id: approve
 | 
			
		||||
        with:
 | 
			
		||||
          github-token: ${{ secrets.GITHUB_TOKEN }}
 | 
			
		||||
							
								
								
									
										21
									
								
								.github.old/workflows/automerge.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										21
									
								
								.github.old/workflows/automerge.yml
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,21 @@
 | 
			
		||||
name: "automerge"
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  pull_request_target:
 | 
			
		||||
    types: [assigned, opened, synchronize, reopened]
 | 
			
		||||
 | 
			
		||||
permissions:
 | 
			
		||||
  pull-requests: write
 | 
			
		||||
  contents: write
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  automerge:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    if: github.actor == 'vtolstov'
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: merge
 | 
			
		||||
        id: merge
 | 
			
		||||
        run: gh pr merge --auto --merge "$PR_URL"
 | 
			
		||||
        env:
 | 
			
		||||
          PR_URL: ${{github.event.pull_request.html_url}}
 | 
			
		||||
          GITHUB_TOKEN: ${{secrets.TOKEN}}
 | 
			
		||||
@@ -1,55 +1,40 @@
 | 
			
		||||
name: build
 | 
			
		||||
on:
 | 
			
		||||
  push:
 | 
			
		||||
 push:
 | 
			
		||||
    branches:
 | 
			
		||||
    - master
 | 
			
		||||
    - v3
 | 
			
		||||
jobs:
 | 
			
		||||
  test:
 | 
			
		||||
    name: test
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
    - name: setup
 | 
			
		||||
      uses: actions/setup-go@v2
 | 
			
		||||
      uses: actions/setup-go@v3
 | 
			
		||||
      with:
 | 
			
		||||
        go-version: 1.16
 | 
			
		||||
        go-version: 1.17
 | 
			
		||||
    - name: checkout
 | 
			
		||||
      uses: actions/checkout@v3
 | 
			
		||||
    - name: cache
 | 
			
		||||
      uses: actions/cache@v2
 | 
			
		||||
      uses: actions/cache@v3
 | 
			
		||||
      with:
 | 
			
		||||
        path: ~/go/pkg/mod
 | 
			
		||||
        key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
 | 
			
		||||
        restore-keys: ${{ runner.os }}-go-
 | 
			
		||||
    - name: sdk checkout
 | 
			
		||||
      uses: actions/checkout@v2
 | 
			
		||||
    - name: sdk deps
 | 
			
		||||
    - name: deps
 | 
			
		||||
      run: go get -v -t -d ./...
 | 
			
		||||
    - name: sdk test
 | 
			
		||||
    - name: test
 | 
			
		||||
      env:
 | 
			
		||||
        INTEGRATION_TESTS: yes
 | 
			
		||||
      run: go test -mod readonly -v ./...
 | 
			
		||||
    - name: tests checkout
 | 
			
		||||
      uses: actions/checkout@v2
 | 
			
		||||
      with:
 | 
			
		||||
        repository: unistack-org/micro-tests
 | 
			
		||||
        ref: refs/heads/master
 | 
			
		||||
        path: micro-tests
 | 
			
		||||
        fetch-depth: 1
 | 
			
		||||
    - name: tests deps
 | 
			
		||||
      run: |
 | 
			
		||||
        cd micro-tests
 | 
			
		||||
        go mod edit -replace="github.com/unistack-org/micro/v3=../"
 | 
			
		||||
        go get -v -t -d ./...
 | 
			
		||||
    - name: tests test
 | 
			
		||||
      env:
 | 
			
		||||
        INTEGRATION_TESTS: yes
 | 
			
		||||
      run: cd micro-tests && go test -mod readonly -v ./...
 | 
			
		||||
  lint:
 | 
			
		||||
    name: lint
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: checkout
 | 
			
		||||
        uses: actions/checkout@v2
 | 
			
		||||
        uses: actions/checkout@v3
 | 
			
		||||
      - name: lint
 | 
			
		||||
        uses: golangci/golangci-lint-action@v2
 | 
			
		||||
        uses: golangci/golangci-lint-action@v3.4.0
 | 
			
		||||
        continue-on-error: true
 | 
			
		||||
        with:
 | 
			
		||||
          # Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
 | 
			
		||||
							
								
								
									
										39
									
								
								.github.old/workflows/codecov.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										39
									
								
								.github.old/workflows/codecov.yml
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,39 @@
 | 
			
		||||
name: "codecov"
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  workflow_run:
 | 
			
		||||
    workflows: ["build"]
 | 
			
		||||
    types:
 | 
			
		||||
      - completed
 | 
			
		||||
  push:
 | 
			
		||||
    branches: [ v3 ]
 | 
			
		||||
  pull_request:
 | 
			
		||||
    branches: [ v3 ]
 | 
			
		||||
  schedule:
 | 
			
		||||
    - cron: '34 1 * * 0'
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  codecov:
 | 
			
		||||
    name: codecov
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    permissions:
 | 
			
		||||
      actions: read
 | 
			
		||||
      contents: read
 | 
			
		||||
      security-events: write
 | 
			
		||||
 | 
			
		||||
    strategy:
 | 
			
		||||
      fail-fast: false
 | 
			
		||||
      matrix:
 | 
			
		||||
        language: [ 'go' ]
 | 
			
		||||
 | 
			
		||||
    steps:
 | 
			
		||||
    - name: checkout
 | 
			
		||||
      uses: actions/checkout@v3
 | 
			
		||||
    - name: setup
 | 
			
		||||
      uses: actions/setup-go@v3
 | 
			
		||||
      with:
 | 
			
		||||
        go-version: 1.17
 | 
			
		||||
    - name: Run coverage
 | 
			
		||||
      run: go test -v -race -coverprofile=coverage.out -covermode=atomic ./...
 | 
			
		||||
    - name: codecov
 | 
			
		||||
      uses: codecov/codecov-action@v3.1.1
 | 
			
		||||
							
								
								
									
										78
									
								
								.github.old/workflows/codeql-analysis.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										78
									
								
								.github.old/workflows/codeql-analysis.yml
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,78 @@
 | 
			
		||||
# For most projects, this workflow file will not need changing; you simply need
 | 
			
		||||
# to commit it to your repository.
 | 
			
		||||
#
 | 
			
		||||
# You may wish to alter this file to override the set of languages analyzed,
 | 
			
		||||
# or to provide custom queries or build logic.
 | 
			
		||||
#
 | 
			
		||||
# ******** NOTE ********
 | 
			
		||||
# We have attempted to detect the languages in your repository. Please check
 | 
			
		||||
# the `language` matrix defined below to confirm you have the correct set of
 | 
			
		||||
# supported CodeQL languages.
 | 
			
		||||
#
 | 
			
		||||
name: "codeql"
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  workflow_run:
 | 
			
		||||
    workflows: ["prbuild"]
 | 
			
		||||
    types:
 | 
			
		||||
      - completed
 | 
			
		||||
  push:
 | 
			
		||||
    branches: [ master, v3 ]
 | 
			
		||||
  pull_request:
 | 
			
		||||
    # The branches below must be a subset of the branches above
 | 
			
		||||
    branches: [ master, v3 ]
 | 
			
		||||
  schedule:
 | 
			
		||||
    - cron: '34 1 * * 0'
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  analyze:
 | 
			
		||||
    name: analyze
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    permissions:
 | 
			
		||||
      actions: read
 | 
			
		||||
      contents: read
 | 
			
		||||
      security-events: write
 | 
			
		||||
 | 
			
		||||
    strategy:
 | 
			
		||||
      fail-fast: false
 | 
			
		||||
      matrix:
 | 
			
		||||
        language: [ 'go' ]
 | 
			
		||||
        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
 | 
			
		||||
        # Learn more:
 | 
			
		||||
        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
 | 
			
		||||
 | 
			
		||||
    steps:
 | 
			
		||||
    - name: checkout
 | 
			
		||||
      uses: actions/checkout@v3
 | 
			
		||||
    - name: setup
 | 
			
		||||
      uses: actions/setup-go@v3
 | 
			
		||||
      with:
 | 
			
		||||
        go-version: 1.17
 | 
			
		||||
    # Initializes the CodeQL tools for scanning.
 | 
			
		||||
    - name: init
 | 
			
		||||
      uses: github/codeql-action/init@v2
 | 
			
		||||
      with:
 | 
			
		||||
        languages: ${{ matrix.language }}
 | 
			
		||||
        # If you wish to specify custom queries, you can do so here or in a config file.
 | 
			
		||||
        # By default, queries listed here will override any specified in a config file.
 | 
			
		||||
        # Prefix the list here with "+" to use these queries and those in the config file.
 | 
			
		||||
        # queries: ./path/to/local/query, your-org/your-repo/queries@main
 | 
			
		||||
 | 
			
		||||
    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
 | 
			
		||||
    # If this step fails, then you should remove it and run the build manually (see below)
 | 
			
		||||
    - name: autobuild
 | 
			
		||||
      uses: github/codeql-action/autobuild@v2
 | 
			
		||||
 | 
			
		||||
    # ℹ️ Command-line programs to run using the OS shell.
 | 
			
		||||
    # 📚 https://git.io/JvXDl
 | 
			
		||||
 | 
			
		||||
    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
 | 
			
		||||
    #    and modify them (or add more) to build your code if your project
 | 
			
		||||
    #    uses a compiled language
 | 
			
		||||
 | 
			
		||||
    #- run: |
 | 
			
		||||
    #   make bootstrap
 | 
			
		||||
    #   make release
 | 
			
		||||
 | 
			
		||||
    - name: analyze
 | 
			
		||||
      uses: github/codeql-action/analyze@v2
 | 
			
		||||
							
								
								
									
										27
									
								
								.github.old/workflows/dependabot-automerge.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										27
									
								
								.github.old/workflows/dependabot-automerge.yml
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,27 @@
 | 
			
		||||
name: "dependabot-automerge"
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  pull_request_target:
 | 
			
		||||
    types: [assigned, opened, synchronize, reopened]
 | 
			
		||||
 | 
			
		||||
permissions:
 | 
			
		||||
  pull-requests: write
 | 
			
		||||
  contents: write
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  automerge:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    if: github.actor == 'dependabot[bot]'
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: metadata
 | 
			
		||||
        id: metadata
 | 
			
		||||
        uses: dependabot/fetch-metadata@v1.3.6
 | 
			
		||||
        with:
 | 
			
		||||
          github-token: "${{ secrets.TOKEN }}"
 | 
			
		||||
      - name: merge
 | 
			
		||||
        id: merge
 | 
			
		||||
        if: ${{contains(steps.metadata.outputs.dependency-names, 'go.unistack.org')}}
 | 
			
		||||
        run: gh pr merge --auto --merge "$PR_URL"
 | 
			
		||||
        env:
 | 
			
		||||
          PR_URL: ${{github.event.pull_request.html_url}}
 | 
			
		||||
          GITHUB_TOKEN: ${{secrets.TOKEN}}
 | 
			
		||||
							
								
								
									
										40
									
								
								.github.old/workflows/pr.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										40
									
								
								.github.old/workflows/pr.yml
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,40 @@
 | 
			
		||||
name: prbuild
 | 
			
		||||
on:
 | 
			
		||||
  pull_request:
 | 
			
		||||
    branches:
 | 
			
		||||
    - master
 | 
			
		||||
    - v3
 | 
			
		||||
jobs:
 | 
			
		||||
  test:
 | 
			
		||||
    name: test
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
    - name: setup
 | 
			
		||||
      uses: actions/setup-go@v3
 | 
			
		||||
      with:
 | 
			
		||||
        go-version: 1.17
 | 
			
		||||
    - name: checkout
 | 
			
		||||
      uses: actions/checkout@v3
 | 
			
		||||
    - name: cache
 | 
			
		||||
      uses: actions/cache@v3
 | 
			
		||||
      with:
 | 
			
		||||
        path: ~/go/pkg/mod
 | 
			
		||||
        key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
 | 
			
		||||
        restore-keys: ${{ runner.os }}-go-
 | 
			
		||||
    - name: deps
 | 
			
		||||
      run: go get -v -t -d ./...
 | 
			
		||||
    - name: test
 | 
			
		||||
      env:
 | 
			
		||||
        INTEGRATION_TESTS: yes
 | 
			
		||||
      run: go test -mod readonly -v ./...
 | 
			
		||||
  lint:
 | 
			
		||||
    name: lint
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: checkout
 | 
			
		||||
        uses: actions/checkout@v3
 | 
			
		||||
      - name: lint
 | 
			
		||||
        uses: golangci/golangci-lint-action@v3.4.0
 | 
			
		||||
        continue-on-error: true
 | 
			
		||||
        with:
 | 
			
		||||
          version: v1.30
 | 
			
		||||
							
								
								
									
										15
									
								
								.github/generate.sh
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										15
									
								
								.github/generate.sh
									
									
									
									
										vendored
									
									
								
							@@ -1,15 +0,0 @@
 | 
			
		||||
#!/bin/bash -e
 | 
			
		||||
 | 
			
		||||
find . -type f -name '*.pb.*.go' -o -name '*.pb.go' -a ! -name 'message.pb.go' -delete
 | 
			
		||||
PROTOS=$(find . -type f -name '*.proto' | grep -v proto/google/api)
 | 
			
		||||
 | 
			
		||||
mkdir -p proto/google/api
 | 
			
		||||
curl -s -o proto/google/api/annotations.proto -L https://raw.githubusercontent.com/googleapis/googleapis/master/google/api/annotations.proto
 | 
			
		||||
curl -s -o proto/google/api/http.proto -L https://raw.githubusercontent.com/googleapis/googleapis/master/google/api/http.proto
 | 
			
		||||
 | 
			
		||||
for PROTO in $PROTOS; do
 | 
			
		||||
  echo $PROTO
 | 
			
		||||
  protoc -I./proto -I. -I$(dirname $PROTO) --go-grpc_out=paths=source_relative:. --go_out=paths=source_relative:. --micro_out=paths=source_relative:. $PROTO
 | 
			
		||||
done
 | 
			
		||||
 | 
			
		||||
rm -r proto
 | 
			
		||||
							
								
								
									
										20
									
								
								.github/renovate.json
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										20
									
								
								.github/renovate.json
									
									
									
									
										vendored
									
									
								
							@@ -1,20 +0,0 @@
 | 
			
		||||
{
 | 
			
		||||
  "extends": [
 | 
			
		||||
    "config:base"
 | 
			
		||||
  ],
 | 
			
		||||
  "postUpdateOptions": ["gomodTidy"],
 | 
			
		||||
  "packageRules": [
 | 
			
		||||
    {
 | 
			
		||||
      "matchUpdateTypes": ["minor", "patch", "pin", "digest"],
 | 
			
		||||
      "automerge": true
 | 
			
		||||
    },
 | 
			
		||||
    {
 | 
			
		||||
      "groupName": "all deps",
 | 
			
		||||
      "separateMajorMinor": true,
 | 
			
		||||
      "groupSlug": "all",
 | 
			
		||||
      "packagePatterns": [
 | 
			
		||||
        "*"
 | 
			
		||||
      ]
 | 
			
		||||
    }
 | 
			
		||||
  ]
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										13
									
								
								.github/stale.sh
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										13
									
								
								.github/stale.sh
									
									
									
									
										vendored
									
									
								
							@@ -1,13 +0,0 @@
 | 
			
		||||
#!/bin/bash -ex
 | 
			
		||||
 | 
			
		||||
export PATH=$PATH:$(pwd)/bin
 | 
			
		||||
export GO111MODULE=on
 | 
			
		||||
export GOBIN=$(pwd)/bin
 | 
			
		||||
 | 
			
		||||
#go get github.com/rvflash/goup@v0.4.1
 | 
			
		||||
 | 
			
		||||
#goup -v ./...
 | 
			
		||||
#go get github.com/psampaz/go-mod-outdated@v0.6.0
 | 
			
		||||
go list -u -m -mod=mod -json all | go-mod-outdated -update -direct -ci || true
 | 
			
		||||
 | 
			
		||||
#go list -u -m -json all | go-mod-outdated -update
 | 
			
		||||
							
								
								
									
										62
									
								
								.github/workflows/pr.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										62
									
								
								.github/workflows/pr.yml
									
									
									
									
										vendored
									
									
								
							@@ -1,62 +0,0 @@
 | 
			
		||||
name: prbuild
 | 
			
		||||
on:
 | 
			
		||||
  pull_request:
 | 
			
		||||
    branches:
 | 
			
		||||
    - master
 | 
			
		||||
jobs:
 | 
			
		||||
  test:
 | 
			
		||||
    name: test
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
    - name: setup
 | 
			
		||||
      uses: actions/setup-go@v2
 | 
			
		||||
      with:
 | 
			
		||||
        go-version: 1.16
 | 
			
		||||
    - name: cache
 | 
			
		||||
      uses: actions/cache@v2
 | 
			
		||||
      with:
 | 
			
		||||
        path: ~/go/pkg
 | 
			
		||||
        key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
 | 
			
		||||
        restore-keys: ${{ runner.os }}-go-
 | 
			
		||||
    - name: sdk checkout
 | 
			
		||||
      uses: actions/checkout@v2
 | 
			
		||||
    - name: sdk deps
 | 
			
		||||
      run: go get -v -t -d ./...
 | 
			
		||||
    - name: sdk test
 | 
			
		||||
      env:
 | 
			
		||||
        INTEGRATION_TESTS: yes
 | 
			
		||||
      run: go test -mod readonly -v ./...
 | 
			
		||||
    - name: tests checkout
 | 
			
		||||
      uses: actions/checkout@v2
 | 
			
		||||
      with:
 | 
			
		||||
        repository: unistack-org/micro-tests
 | 
			
		||||
        ref: refs/heads/master
 | 
			
		||||
        path: micro-tests
 | 
			
		||||
        fetch-depth: 1
 | 
			
		||||
    - name: tests deps
 | 
			
		||||
      run: |
 | 
			
		||||
        cd micro-tests
 | 
			
		||||
        go mod edit -replace="github.com/unistack-org/micro/v3=../"
 | 
			
		||||
        go get -v -t -d ./...
 | 
			
		||||
    - name: tests test
 | 
			
		||||
      env:
 | 
			
		||||
        INTEGRATION_TESTS: yes
 | 
			
		||||
      run: cd micro-tests && go test -mod readonly -v ./...
 | 
			
		||||
  lint:
 | 
			
		||||
    name: lint
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: checkout
 | 
			
		||||
        uses: actions/checkout@v2
 | 
			
		||||
      - name: lint
 | 
			
		||||
        uses: golangci/golangci-lint-action@v2
 | 
			
		||||
        continue-on-error: true
 | 
			
		||||
        with:
 | 
			
		||||
          # Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
 | 
			
		||||
          version: v1.30
 | 
			
		||||
          # Optional: working directory, useful for monorepos
 | 
			
		||||
          # working-directory: somedir
 | 
			
		||||
          # Optional: golangci-lint command line arguments.
 | 
			
		||||
          # args: --issues-exit-code=0
 | 
			
		||||
          # Optional: show only new issues if it's a pull request. The default value is `false`.
 | 
			
		||||
          # only-new-issues: true
 | 
			
		||||
							
								
								
									
										3
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							@@ -1,6 +1,8 @@
 | 
			
		||||
# Develop tools
 | 
			
		||||
/.vscode/
 | 
			
		||||
/.idea/
 | 
			
		||||
.idea
 | 
			
		||||
.vscode
 | 
			
		||||
 | 
			
		||||
# Binaries for programs and plugins
 | 
			
		||||
*.exe
 | 
			
		||||
@@ -13,6 +15,7 @@
 | 
			
		||||
_obj
 | 
			
		||||
_test
 | 
			
		||||
_build
 | 
			
		||||
.DS_Store
 | 
			
		||||
 | 
			
		||||
# Architecture specific extensions/prefixes
 | 
			
		||||
*.[568vq]
 | 
			
		||||
 
 | 
			
		||||
@@ -1,30 +1,5 @@
 | 
			
		||||
run:
 | 
			
		||||
  concurrency: 8
 | 
			
		||||
  deadline: 5m
 | 
			
		||||
  modules-download-mode: readonly
 | 
			
		||||
  skip-files:
 | 
			
		||||
    - ".*\\.pb\\.go$"
 | 
			
		||||
    - ".*\\.pb\\.micro\\.go$"
 | 
			
		||||
linters:
 | 
			
		||||
  disable-all: false
 | 
			
		||||
  enable-all: false
 | 
			
		||||
  enable:
 | 
			
		||||
    - megacheck
 | 
			
		||||
    - staticcheck
 | 
			
		||||
    - deadcode
 | 
			
		||||
    - varcheck
 | 
			
		||||
    - gosimple
 | 
			
		||||
    - unused
 | 
			
		||||
    - prealloc
 | 
			
		||||
    - scopelint
 | 
			
		||||
    - gocritic
 | 
			
		||||
    - goimports
 | 
			
		||||
    - unconvert
 | 
			
		||||
    - govet
 | 
			
		||||
    - nakedret
 | 
			
		||||
    - structcheck
 | 
			
		||||
    - gosec
 | 
			
		||||
  disable:
 | 
			
		||||
    - maligned
 | 
			
		||||
    - interfacer
 | 
			
		||||
    - typecheck
 | 
			
		||||
    - dupl
 | 
			
		||||
  issues-exit-code: 1
 | 
			
		||||
  tests: true
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										27
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										27
									
								
								README.md
									
									
									
									
									
								
							@@ -1,4 +1,9 @@
 | 
			
		||||
# Micro [](https://opensource.org/licenses/Apache-2.0) [](https://pkg.go.dev/github.com/unistack-org/micro/v3?tab=overview) [](https://github.com/unistack-org/micro/actions?query=workflow%3Abuild+branch%3Amaster+event%3Apush) [](https://goreportcard.com/report/github.com/unistack-org/micro) [](https://unistack-org.slack.com/messages/default)
 | 
			
		||||
# Micro
 | 
			
		||||

 | 
			
		||||
[](https://opensource.org/licenses/Apache-2.0)
 | 
			
		||||
[](https://pkg.go.dev/go.unistack.org/micro/v4?tab=overview)
 | 
			
		||||
[](https://git.unistack.org/unistack-org/micro/actions?query=workflow%3Abuild+branch%3Av4+event%3Apush)
 | 
			
		||||
[](https://goreportcard.com/report/go.unistack.org/micro/v4)
 | 
			
		||||
 | 
			
		||||
Micro is a standard library for microservices.
 | 
			
		||||
 | 
			
		||||
@@ -10,30 +15,20 @@ Micro provides the core requirements for distributed systems development includi
 | 
			
		||||
 | 
			
		||||
Micro abstracts away the details of distributed systems. Here are the main features.
 | 
			
		||||
 | 
			
		||||
- **Authentication** - Auth is built in as a first class citizen. Authentication and authorization enable secure 
 | 
			
		||||
zero trust networking by providing every service an identity and certificates. This additionally includes rule 
 | 
			
		||||
based access control.
 | 
			
		||||
 | 
			
		||||
- **Dynamic Config** - Load and hot reload dynamic config from anywhere. The config interface provides a way to load application 
 | 
			
		||||
level config from any source such as env vars, file, etcd. You can merge the sources and even define fallbacks.
 | 
			
		||||
level config from any source such as env vars, cmdline, file, consul, vault... You can merge the sources and even define fallbacks.
 | 
			
		||||
 | 
			
		||||
- **Data Storage** - A simple data store interface to read, write and delete records. It includes support for memory, file and 
 | 
			
		||||
CockroachDB by default. State and persistence becomes a core requirement beyond prototyping and Micro looks to build that into the framework.
 | 
			
		||||
s3. State and persistence becomes a core requirement beyond prototyping and Micro looks to build that into the framework.
 | 
			
		||||
 | 
			
		||||
- **Service Discovery** - Automatic service registration and name resolution. Service discovery is at the core of micro service 
 | 
			
		||||
development. When service A needs to speak to service B it needs the location of that service.
 | 
			
		||||
 | 
			
		||||
- **Load Balancing** - Client side load balancing built on service discovery. Once we have the addresses of any number of instances 
 | 
			
		||||
of a service we now need a way to decide which node to route to. We use random hashed load balancing to provide even distribution 
 | 
			
		||||
across the services and retry a different node if there's a problem. 
 | 
			
		||||
 | 
			
		||||
- **Message Encoding** - Dynamic message encoding based on content-type. The client and server will use codecs along with content-type 
 | 
			
		||||
to seamlessly encode and decode Go types for you. Any variety of messages could be encoded and sent from different clients. The client 
 | 
			
		||||
and server handle this by default.
 | 
			
		||||
 | 
			
		||||
- **Transport** - gRPC or http based request/response with support for bidirectional streaming. We provide an abstraction for synchronous communication. A request made to a service will be automatically resolved, load balanced, dialled and streamed.
 | 
			
		||||
 | 
			
		||||
- **Async Messaging** - PubSub is built in as a first class citizen for asynchronous communication and event driven architectures.
 | 
			
		||||
- **Async Messaging** - Pub/Sub is built in as a first class citizen for asynchronous communication and event driven architectures.
 | 
			
		||||
Event notifications are a core pattern in micro service development.
 | 
			
		||||
 | 
			
		||||
- **Synchronization** - Distributed systems are often built in an eventually consistent manner. Support for distributed locking and 
 | 
			
		||||
@@ -42,10 +37,6 @@ leadership are built in as a Sync interface. When using an eventually consistent
 | 
			
		||||
- **Pluggable Interfaces** - Micro makes use of Go interfaces for each system abstraction. Because of this these interfaces 
 | 
			
		||||
are pluggable and allows Micro to be runtime agnostic.
 | 
			
		||||
 | 
			
		||||
## Getting Started
 | 
			
		||||
 | 
			
		||||
To be created.
 | 
			
		||||
 | 
			
		||||
## License
 | 
			
		||||
 | 
			
		||||
Micro is Apache 2.0 licensed.
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										15
									
								
								SECURITY.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								SECURITY.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,15 @@
 | 
			
		||||
# Security Policy
 | 
			
		||||
 | 
			
		||||
## Supported Versions
 | 
			
		||||
 | 
			
		||||
Use this section to tell people about which versions of your project are
 | 
			
		||||
currently being supported with security updates.
 | 
			
		||||
 | 
			
		||||
| Version | Supported          |
 | 
			
		||||
| ------- | ------------------ |
 | 
			
		||||
| 3.7.x   | :white_check_mark: |
 | 
			
		||||
| < 3.7.0 | :x:                |
 | 
			
		||||
 | 
			
		||||
## Reporting a Vulnerability
 | 
			
		||||
 | 
			
		||||
If you find any issue, please create github issue in this repo
 | 
			
		||||
							
								
								
									
										181
									
								
								api/api.go
									
									
									
									
									
								
							
							
						
						
									
										181
									
								
								api/api.go
									
									
									
									
									
								
							@@ -1,181 +0,0 @@
 | 
			
		||||
package api
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"errors"
 | 
			
		||||
	"regexp"
 | 
			
		||||
	"strings"
 | 
			
		||||
 | 
			
		||||
	"github.com/unistack-org/micro/v3/metadata"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/register"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/server"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Api interface
 | 
			
		||||
type Api interface {
 | 
			
		||||
	// Initialise options
 | 
			
		||||
	Init(...Option) error
 | 
			
		||||
	// Get the options
 | 
			
		||||
	Options() Options
 | 
			
		||||
	// Register a http handler
 | 
			
		||||
	Register(*Endpoint) error
 | 
			
		||||
	// Register a route
 | 
			
		||||
	Deregister(*Endpoint) error
 | 
			
		||||
	// Implementation of api
 | 
			
		||||
	String() string
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Options holds the options
 | 
			
		||||
type Options struct{}
 | 
			
		||||
 | 
			
		||||
// Option func signature
 | 
			
		||||
type Option func(*Options) error
 | 
			
		||||
 | 
			
		||||
// Endpoint is a mapping between an RPC method and HTTP endpoint
 | 
			
		||||
type Endpoint struct {
 | 
			
		||||
	// Name Greeter.Hello
 | 
			
		||||
	Name string
 | 
			
		||||
	// Description e.g what's this endpoint for
 | 
			
		||||
	Description string
 | 
			
		||||
	// Handler e.g rpc, proxy
 | 
			
		||||
	Handler string
 | 
			
		||||
	// Host e.g example.com
 | 
			
		||||
	Host []string
 | 
			
		||||
	// Method e.g GET, POST
 | 
			
		||||
	Method []string
 | 
			
		||||
	// Path e.g /greeter. Expect POSIX regex
 | 
			
		||||
	Path []string
 | 
			
		||||
	// Body destination
 | 
			
		||||
	// "*" or "" - top level message value
 | 
			
		||||
	// "string" - inner message value
 | 
			
		||||
	Body string
 | 
			
		||||
	// Stream flag
 | 
			
		||||
	Stream bool
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Service represents an API service
 | 
			
		||||
type Service struct {
 | 
			
		||||
	// Name of service
 | 
			
		||||
	Name string
 | 
			
		||||
	// Endpoint for this service
 | 
			
		||||
	Endpoint *Endpoint
 | 
			
		||||
	// Services that provides service
 | 
			
		||||
	Services []*register.Service
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Encode encodes an endpoint to endpoint metadata
 | 
			
		||||
func Encode(e *Endpoint) map[string]string {
 | 
			
		||||
	if e == nil {
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// endpoint map
 | 
			
		||||
	ep := make(map[string]string)
 | 
			
		||||
 | 
			
		||||
	// set vals only if they exist
 | 
			
		||||
	set := func(k, v string) {
 | 
			
		||||
		if len(v) == 0 {
 | 
			
		||||
			return
 | 
			
		||||
		}
 | 
			
		||||
		ep[k] = v
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	set("endpoint", e.Name)
 | 
			
		||||
	set("description", e.Description)
 | 
			
		||||
	set("handler", e.Handler)
 | 
			
		||||
	set("method", strings.Join(e.Method, ","))
 | 
			
		||||
	set("path", strings.Join(e.Path, ","))
 | 
			
		||||
	set("host", strings.Join(e.Host, ","))
 | 
			
		||||
	set("body", e.Body)
 | 
			
		||||
 | 
			
		||||
	return ep
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Decode decodes endpoint metadata into an endpoint
 | 
			
		||||
func Decode(e metadata.Metadata) *Endpoint {
 | 
			
		||||
	if e == nil {
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	ep := &Endpoint{}
 | 
			
		||||
	ep.Name, _ = e.Get("endpoint")
 | 
			
		||||
	ep.Description, _ = e.Get("description")
 | 
			
		||||
	epmethod, _ := e.Get("method")
 | 
			
		||||
	ep.Method = []string{epmethod}
 | 
			
		||||
	eppath, _ := e.Get("path")
 | 
			
		||||
	ep.Path = []string{eppath}
 | 
			
		||||
	ephost, _ := e.Get("host")
 | 
			
		||||
	ep.Host = []string{ephost}
 | 
			
		||||
	ep.Handler, _ = e.Get("handler")
 | 
			
		||||
	ep.Body, _ = e.Get("body")
 | 
			
		||||
 | 
			
		||||
	return ep
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Validate validates an endpoint to guarantee it won't blow up when being served
 | 
			
		||||
func Validate(e *Endpoint) error {
 | 
			
		||||
	if e == nil {
 | 
			
		||||
		return errors.New("endpoint is nil")
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if len(e.Name) == 0 {
 | 
			
		||||
		return errors.New("name required")
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	for _, p := range e.Path {
 | 
			
		||||
		ps := p[0]
 | 
			
		||||
		pe := p[len(p)-1]
 | 
			
		||||
 | 
			
		||||
		if ps == '^' && pe == '$' {
 | 
			
		||||
			_, err := regexp.CompilePOSIX(p)
 | 
			
		||||
			if err != nil {
 | 
			
		||||
				return err
 | 
			
		||||
			}
 | 
			
		||||
		} else if ps == '^' && pe != '$' {
 | 
			
		||||
			return errors.New("invalid path")
 | 
			
		||||
		} else if ps != '^' && pe == '$' {
 | 
			
		||||
			return errors.New("invalid path")
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if len(e.Handler) == 0 {
 | 
			
		||||
		return errors.New("invalid handler")
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/*
 | 
			
		||||
Design ideas
 | 
			
		||||
 | 
			
		||||
// Gateway is an api gateway interface
 | 
			
		||||
type Gateway interface {
 | 
			
		||||
	// Register a http handler
 | 
			
		||||
	Handle(pattern string, http.Handler)
 | 
			
		||||
	// Register a route
 | 
			
		||||
	RegisterRoute(r Route)
 | 
			
		||||
	// Init initialises the command line.
 | 
			
		||||
	// It also parses further options.
 | 
			
		||||
	Init(...Option) error
 | 
			
		||||
	// Run the gateway
 | 
			
		||||
	Run() error
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewGateway returns a new api gateway
 | 
			
		||||
func NewGateway() Gateway {
 | 
			
		||||
	return newGateway()
 | 
			
		||||
}
 | 
			
		||||
*/
 | 
			
		||||
 | 
			
		||||
// WithEndpoint returns a server.HandlerOption with endpoint metadata set
 | 
			
		||||
//
 | 
			
		||||
// Usage:
 | 
			
		||||
//
 | 
			
		||||
// 	proto.RegisterHandler(service.Server(), new(Handler), api.WithEndpoint(
 | 
			
		||||
//		&api.Endpoint{
 | 
			
		||||
//			Name: "Greeter.Hello",
 | 
			
		||||
//			Path: []string{"/greeter"},
 | 
			
		||||
//		},
 | 
			
		||||
//	))
 | 
			
		||||
func WithEndpoint(e *Endpoint) server.HandlerOption {
 | 
			
		||||
	return server.EndpointMetadata(e.Name, Encode(e))
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										153
									
								
								api/api_test.go
									
									
									
									
									
								
							
							
						
						
									
										153
									
								
								api/api_test.go
									
									
									
									
									
								
							@@ -1,153 +0,0 @@
 | 
			
		||||
package api
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"strings"
 | 
			
		||||
	"testing"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
//nolint:gocyclo
 | 
			
		||||
func TestEncoding(t *testing.T) {
 | 
			
		||||
	testData := []*Endpoint{
 | 
			
		||||
		nil,
 | 
			
		||||
		{
 | 
			
		||||
			Name:        "Foo.Bar",
 | 
			
		||||
			Description: "A test endpoint",
 | 
			
		||||
			Handler:     "meta",
 | 
			
		||||
			Host:        []string{"foo.com"},
 | 
			
		||||
			Method:      []string{"GET"},
 | 
			
		||||
			Path:        []string{"/test"},
 | 
			
		||||
		},
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	compare := func(expect, got []string) bool {
 | 
			
		||||
		// no data to compare, return true
 | 
			
		||||
		if len(expect) == 0 && len(got) == 0 {
 | 
			
		||||
			return true
 | 
			
		||||
		}
 | 
			
		||||
		// no data expected but got some return false
 | 
			
		||||
		if len(expect) == 0 && len(got) > 0 {
 | 
			
		||||
			return false
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		// compare expected with what we got
 | 
			
		||||
		for _, e := range expect {
 | 
			
		||||
			var seen bool
 | 
			
		||||
			for _, g := range got {
 | 
			
		||||
				if e == g {
 | 
			
		||||
					seen = true
 | 
			
		||||
					break
 | 
			
		||||
				}
 | 
			
		||||
			}
 | 
			
		||||
			if !seen {
 | 
			
		||||
				return false
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		// we're done, return true
 | 
			
		||||
		return true
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	for _, d := range testData {
 | 
			
		||||
		// encode
 | 
			
		||||
		e := Encode(d)
 | 
			
		||||
		// decode
 | 
			
		||||
		de := Decode(e)
 | 
			
		||||
 | 
			
		||||
		// nil endpoint returns nil
 | 
			
		||||
		if d == nil {
 | 
			
		||||
			if e != nil {
 | 
			
		||||
				t.Fatalf("expected nil got %v", e)
 | 
			
		||||
			}
 | 
			
		||||
			if de != nil {
 | 
			
		||||
				t.Fatalf("expected nil got %v", de)
 | 
			
		||||
			}
 | 
			
		||||
 | 
			
		||||
			continue
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		// check encoded map
 | 
			
		||||
		name := e["endpoint"]
 | 
			
		||||
		desc := e["description"]
 | 
			
		||||
		method := strings.Split(e["method"], ",")
 | 
			
		||||
		path := strings.Split(e["path"], ",")
 | 
			
		||||
		host := strings.Split(e["host"], ",")
 | 
			
		||||
		handler := e["handler"]
 | 
			
		||||
 | 
			
		||||
		if name != d.Name {
 | 
			
		||||
			t.Fatalf("expected %v got %v", d.Name, name)
 | 
			
		||||
		}
 | 
			
		||||
		if desc != d.Description {
 | 
			
		||||
			t.Fatalf("expected %v got %v", d.Description, desc)
 | 
			
		||||
		}
 | 
			
		||||
		if handler != d.Handler {
 | 
			
		||||
			t.Fatalf("expected %v got %v", d.Handler, handler)
 | 
			
		||||
		}
 | 
			
		||||
		if ok := compare(d.Method, method); !ok {
 | 
			
		||||
			t.Fatalf("expected %v got %v", d.Method, method)
 | 
			
		||||
		}
 | 
			
		||||
		if ok := compare(d.Path, path); !ok {
 | 
			
		||||
			t.Fatalf("expected %v got %v", d.Path, path)
 | 
			
		||||
		}
 | 
			
		||||
		if ok := compare(d.Host, host); !ok {
 | 
			
		||||
			t.Fatalf("expected %v got %v", d.Host, host)
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		if de.Name != d.Name {
 | 
			
		||||
			t.Fatalf("expected %v got %v", d.Name, de.Name)
 | 
			
		||||
		}
 | 
			
		||||
		if de.Description != d.Description {
 | 
			
		||||
			t.Fatalf("expected %v got %v", d.Description, de.Description)
 | 
			
		||||
		}
 | 
			
		||||
		if de.Handler != d.Handler {
 | 
			
		||||
			t.Fatalf("expected %v got %v", d.Handler, de.Handler)
 | 
			
		||||
		}
 | 
			
		||||
		if ok := compare(d.Method, de.Method); !ok {
 | 
			
		||||
			t.Fatalf("expected %v got %v", d.Method, de.Method)
 | 
			
		||||
		}
 | 
			
		||||
		if ok := compare(d.Path, de.Path); !ok {
 | 
			
		||||
			t.Fatalf("expected %v got %v", d.Path, de.Path)
 | 
			
		||||
		}
 | 
			
		||||
		if ok := compare(d.Host, de.Host); !ok {
 | 
			
		||||
			t.Fatalf("expected %v got %v", d.Host, de.Host)
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestValidate(t *testing.T) {
 | 
			
		||||
	epPcre := &Endpoint{
 | 
			
		||||
		Name:        "Foo.Bar",
 | 
			
		||||
		Description: "A test endpoint",
 | 
			
		||||
		Handler:     "meta",
 | 
			
		||||
		Host:        []string{"foo.com"},
 | 
			
		||||
		Method:      []string{"GET"},
 | 
			
		||||
		Path:        []string{"^/test/?$"},
 | 
			
		||||
	}
 | 
			
		||||
	if err := Validate(epPcre); err != nil {
 | 
			
		||||
		t.Fatal(err)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	epGpath := &Endpoint{
 | 
			
		||||
		Name:        "Foo.Bar",
 | 
			
		||||
		Description: "A test endpoint",
 | 
			
		||||
		Handler:     "meta",
 | 
			
		||||
		Host:        []string{"foo.com"},
 | 
			
		||||
		Method:      []string{"GET"},
 | 
			
		||||
		Path:        []string{"/test/{id}"},
 | 
			
		||||
	}
 | 
			
		||||
	if err := Validate(epGpath); err != nil {
 | 
			
		||||
		t.Fatal(err)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	epPcreInvalid := &Endpoint{
 | 
			
		||||
		Name:        "Foo.Bar",
 | 
			
		||||
		Description: "A test endpoint",
 | 
			
		||||
		Handler:     "meta",
 | 
			
		||||
		Host:        []string{"foo.com"},
 | 
			
		||||
		Method:      []string{"GET"},
 | 
			
		||||
		Path:        []string{"/test/?$"},
 | 
			
		||||
	}
 | 
			
		||||
	if err := Validate(epPcreInvalid); err == nil {
 | 
			
		||||
		t.Fatalf("invalid pcre %v", epPcreInvalid.Path[0])
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
}
 | 
			
		||||
@@ -1,14 +0,0 @@
 | 
			
		||||
// Package handler provides http handlers
 | 
			
		||||
package handler
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"net/http"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Handler represents a HTTP handler that manages a request
 | 
			
		||||
type Handler interface {
 | 
			
		||||
	// standard http handler
 | 
			
		||||
	http.Handler
 | 
			
		||||
	// name of handler
 | 
			
		||||
	String() string
 | 
			
		||||
}
 | 
			
		||||
@@ -1,72 +0,0 @@
 | 
			
		||||
package handler
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"github.com/unistack-org/micro/v3/api/router"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/client"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/logger"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
var (
 | 
			
		||||
	// DefaultMaxRecvSize specifies max recv size for handler
 | 
			
		||||
	DefaultMaxRecvSize int64 = 1024 * 1024 * 100 // 10Mb
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Options struct holds handler options
 | 
			
		||||
type Options struct {
 | 
			
		||||
	MaxRecvSize int64
 | 
			
		||||
	Namespace   string
 | 
			
		||||
	Router      router.Router
 | 
			
		||||
	Client      client.Client
 | 
			
		||||
	Logger      logger.Logger
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Option func signature
 | 
			
		||||
type Option func(o *Options)
 | 
			
		||||
 | 
			
		||||
// NewOptions creates new options struct and fills it
 | 
			
		||||
func NewOptions(opts ...Option) Options {
 | 
			
		||||
	options := Options{
 | 
			
		||||
		Client:      client.DefaultClient,
 | 
			
		||||
		Router:      router.DefaultRouter,
 | 
			
		||||
		Logger:      logger.DefaultLogger,
 | 
			
		||||
		MaxRecvSize: DefaultMaxRecvSize,
 | 
			
		||||
	}
 | 
			
		||||
	for _, o := range opts {
 | 
			
		||||
		o(&options)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// set namespace if blank
 | 
			
		||||
	if len(options.Namespace) == 0 {
 | 
			
		||||
		WithNamespace("go.micro.api")(&options)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return options
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithNamespace specifies the namespace for the handler
 | 
			
		||||
func WithNamespace(s string) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.Namespace = s
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithRouter specifies a router to be used by the handler
 | 
			
		||||
func WithRouter(r router.Router) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.Router = r
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithClient specifies client to be used by the handler
 | 
			
		||||
func WithClient(c client.Client) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.Client = c
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithMaxRecvSize specifies max body size
 | 
			
		||||
func WithMaxRecvSize(size int64) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.MaxRecvSize = size
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
@@ -1,47 +0,0 @@
 | 
			
		||||
// Package grpc resolves a grpc service like /greeter.Say/Hello to greeter service
 | 
			
		||||
package grpc
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"errors"
 | 
			
		||||
	"net/http"
 | 
			
		||||
	"strings"
 | 
			
		||||
 | 
			
		||||
	"github.com/unistack-org/micro/v3/api/resolver"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Resolver struct
 | 
			
		||||
type Resolver struct {
 | 
			
		||||
	opts resolver.Options
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Resolve func to resolve enndpoint
 | 
			
		||||
func (r *Resolver) Resolve(req *http.Request, opts ...resolver.ResolveOption) (*resolver.Endpoint, error) {
 | 
			
		||||
	// parse options
 | 
			
		||||
	options := resolver.NewResolveOptions(opts...)
 | 
			
		||||
 | 
			
		||||
	// /foo.Bar/Service
 | 
			
		||||
	if req.URL.Path == "/" {
 | 
			
		||||
		return nil, errors.New("unknown name")
 | 
			
		||||
	}
 | 
			
		||||
	// [foo.Bar, Service]
 | 
			
		||||
	parts := strings.Split(req.URL.Path[1:], "/")
 | 
			
		||||
	// [foo, Bar]
 | 
			
		||||
	name := strings.Split(parts[0], ".")
 | 
			
		||||
	// foo
 | 
			
		||||
	return &resolver.Endpoint{
 | 
			
		||||
		Name:   strings.Join(name[:len(name)-1], "."),
 | 
			
		||||
		Host:   req.Host,
 | 
			
		||||
		Method: req.Method,
 | 
			
		||||
		Path:   req.URL.Path,
 | 
			
		||||
		Domain: options.Domain,
 | 
			
		||||
	}, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (r *Resolver) String() string {
 | 
			
		||||
	return "grpc"
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewResolver is used to create new Resolver
 | 
			
		||||
func NewResolver(opts ...resolver.Option) resolver.Resolver {
 | 
			
		||||
	return &Resolver{opts: resolver.NewOptions(opts...)}
 | 
			
		||||
}
 | 
			
		||||
@@ -1,35 +0,0 @@
 | 
			
		||||
// Package host resolves using http host
 | 
			
		||||
package host
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"net/http"
 | 
			
		||||
 | 
			
		||||
	"github.com/unistack-org/micro/v3/api/resolver"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
type hostResolver struct {
 | 
			
		||||
	opts resolver.Options
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Resolve endpoint
 | 
			
		||||
func (r *hostResolver) Resolve(req *http.Request, opts ...resolver.ResolveOption) (*resolver.Endpoint, error) {
 | 
			
		||||
	// parse options
 | 
			
		||||
	options := resolver.NewResolveOptions(opts...)
 | 
			
		||||
 | 
			
		||||
	return &resolver.Endpoint{
 | 
			
		||||
		Name:   req.Host,
 | 
			
		||||
		Host:   req.Host,
 | 
			
		||||
		Method: req.Method,
 | 
			
		||||
		Path:   req.URL.Path,
 | 
			
		||||
		Domain: options.Domain,
 | 
			
		||||
	}, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (r *hostResolver) String() string {
 | 
			
		||||
	return "host"
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewResolver creates new host api resolver
 | 
			
		||||
func NewResolver(opts ...resolver.Option) resolver.Resolver {
 | 
			
		||||
	return &hostResolver{opts: resolver.NewOptions(opts...)}
 | 
			
		||||
}
 | 
			
		||||
@@ -1,67 +0,0 @@
 | 
			
		||||
package resolver
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
 | 
			
		||||
	"github.com/unistack-org/micro/v3/register"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Options struct
 | 
			
		||||
type Options struct {
 | 
			
		||||
	Handler       string
 | 
			
		||||
	ServicePrefix string
 | 
			
		||||
	Context       context.Context
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Option func
 | 
			
		||||
type Option func(o *Options)
 | 
			
		||||
 | 
			
		||||
// WithHandler sets the handler being used
 | 
			
		||||
func WithHandler(h string) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.Handler = h
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithServicePrefix sets the ServicePrefix option
 | 
			
		||||
func WithServicePrefix(p string) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.ServicePrefix = p
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewOptions returns new initialised options
 | 
			
		||||
func NewOptions(opts ...Option) Options {
 | 
			
		||||
	options := Options{
 | 
			
		||||
		Context: context.Background(),
 | 
			
		||||
	}
 | 
			
		||||
	for _, o := range opts {
 | 
			
		||||
		o(&options)
 | 
			
		||||
	}
 | 
			
		||||
	return options
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// ResolveOptions are used when resolving a request
 | 
			
		||||
type ResolveOptions struct {
 | 
			
		||||
	Domain string
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// ResolveOption sets an option
 | 
			
		||||
type ResolveOption func(*ResolveOptions)
 | 
			
		||||
 | 
			
		||||
// Domain sets the resolve Domain option
 | 
			
		||||
func Domain(n string) ResolveOption {
 | 
			
		||||
	return func(o *ResolveOptions) {
 | 
			
		||||
		o.Domain = n
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewResolveOptions returns new initialised resolve options
 | 
			
		||||
func NewResolveOptions(opts ...ResolveOption) ResolveOptions {
 | 
			
		||||
	options := ResolveOptions{Domain: register.DefaultDomain}
 | 
			
		||||
	for _, o := range opts {
 | 
			
		||||
		o(&options)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return options
 | 
			
		||||
}
 | 
			
		||||
@@ -1,44 +0,0 @@
 | 
			
		||||
// Package path resolves using http path
 | 
			
		||||
package path
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"net/http"
 | 
			
		||||
	"strings"
 | 
			
		||||
 | 
			
		||||
	"github.com/unistack-org/micro/v3/api/resolver"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Resolver the path resolver
 | 
			
		||||
type Resolver struct {
 | 
			
		||||
	opts resolver.Options
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Resolve resolves endpoint
 | 
			
		||||
func (r *Resolver) Resolve(req *http.Request, opts ...resolver.ResolveOption) (*resolver.Endpoint, error) {
 | 
			
		||||
	// parse options
 | 
			
		||||
	options := resolver.NewResolveOptions(opts...)
 | 
			
		||||
 | 
			
		||||
	if req.URL.Path == "/" {
 | 
			
		||||
		return nil, resolver.ErrNotFound
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	parts := strings.Split(req.URL.Path[1:], "/")
 | 
			
		||||
 | 
			
		||||
	return &resolver.Endpoint{
 | 
			
		||||
		Name:   r.opts.ServicePrefix + "." + parts[0],
 | 
			
		||||
		Host:   req.Host,
 | 
			
		||||
		Method: req.Method,
 | 
			
		||||
		Path:   req.URL.Path,
 | 
			
		||||
		Domain: options.Domain,
 | 
			
		||||
	}, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// String retruns the string representation
 | 
			
		||||
func (r *Resolver) String() string {
 | 
			
		||||
	return "path"
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewResolver returns new path resolver
 | 
			
		||||
func NewResolver(opts ...resolver.Option) resolver.Resolver {
 | 
			
		||||
	return &Resolver{opts: resolver.NewOptions(opts...)}
 | 
			
		||||
}
 | 
			
		||||
@@ -1,34 +0,0 @@
 | 
			
		||||
// Package resolver resolves a http request to an endpoint
 | 
			
		||||
package resolver
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"errors"
 | 
			
		||||
	"net/http"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
var (
 | 
			
		||||
	// ErrNotFound returned when endpoint is not found
 | 
			
		||||
	ErrNotFound = errors.New("not found")
 | 
			
		||||
	// ErrInvalidPath returned on invalid path
 | 
			
		||||
	ErrInvalidPath = errors.New("invalid path")
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Resolver resolves requests to endpoints
 | 
			
		||||
type Resolver interface {
 | 
			
		||||
	Resolve(r *http.Request, opts ...ResolveOption) (*Endpoint, error)
 | 
			
		||||
	String() string
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Endpoint is the endpoint for a http request
 | 
			
		||||
type Endpoint struct {
 | 
			
		||||
	// Endpoint name e.g greeter
 | 
			
		||||
	Name string
 | 
			
		||||
	// HTTP Host e.g example.com
 | 
			
		||||
	Host string
 | 
			
		||||
	// HTTP Methods e.g GET, POST
 | 
			
		||||
	Method string
 | 
			
		||||
	// HTTP Path e.g /greeter.
 | 
			
		||||
	Path string
 | 
			
		||||
	// Domain endpoint exists within
 | 
			
		||||
	Domain string
 | 
			
		||||
}
 | 
			
		||||
@@ -1,90 +0,0 @@
 | 
			
		||||
// Package subdomain is a resolver which uses the subdomain to determine the domain to route to. It
 | 
			
		||||
// offloads the endpoint resolution to a child resolver which is provided in New.
 | 
			
		||||
package subdomain
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"net"
 | 
			
		||||
	"net/http"
 | 
			
		||||
	"strings"
 | 
			
		||||
 | 
			
		||||
	"github.com/unistack-org/micro/v3/api/resolver"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/logger"
 | 
			
		||||
	"golang.org/x/net/publicsuffix"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// NewResolver creates new subdomain api resolver
 | 
			
		||||
func NewResolver(parent resolver.Resolver, opts ...resolver.Option) resolver.Resolver {
 | 
			
		||||
	options := resolver.NewOptions(opts...)
 | 
			
		||||
	return &subdomainResolver{options, parent}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
type subdomainResolver struct {
 | 
			
		||||
	opts resolver.Options
 | 
			
		||||
	resolver.Resolver
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Resolve resolve endpoint based on subdomain
 | 
			
		||||
func (r *subdomainResolver) Resolve(req *http.Request, opts ...resolver.ResolveOption) (*resolver.Endpoint, error) {
 | 
			
		||||
	if dom := r.Domain(req); len(dom) > 0 {
 | 
			
		||||
		opts = append(opts, resolver.Domain(dom))
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return r.Resolver.Resolve(req, opts...)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Domain returns domain
 | 
			
		||||
func (r *subdomainResolver) Domain(req *http.Request) string {
 | 
			
		||||
	// determine the host, e.g. foobar.m3o.app
 | 
			
		||||
	host := req.URL.Hostname()
 | 
			
		||||
	if len(host) == 0 {
 | 
			
		||||
		if h, _, err := net.SplitHostPort(req.Host); err == nil {
 | 
			
		||||
			host = h // host does contain a port
 | 
			
		||||
		} else if strings.Contains(err.Error(), "missing port in address") {
 | 
			
		||||
			host = req.Host // host does not contain a port
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// check for an ip address
 | 
			
		||||
	if net.ParseIP(host) != nil {
 | 
			
		||||
		return ""
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// check for dev environment
 | 
			
		||||
	if host == "localhost" || host == "127.0.0.1" {
 | 
			
		||||
		return ""
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// extract the top level domain plus one (e.g. 'myapp.com')
 | 
			
		||||
	domain, err := publicsuffix.EffectiveTLDPlusOne(host)
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		if logger.V(logger.DebugLevel) {
 | 
			
		||||
			logger.Debug(r.opts.Context, "Unable to extract domain from %v", host)
 | 
			
		||||
		}
 | 
			
		||||
		return ""
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// there was no subdomain
 | 
			
		||||
	if host == domain {
 | 
			
		||||
		return ""
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// remove the domain from the host, leaving the subdomain, e.g. "staging.foo.myapp.com" => "staging.foo"
 | 
			
		||||
	subdomain := strings.TrimSuffix(host, "."+domain)
 | 
			
		||||
 | 
			
		||||
	// ignore the API subdomain
 | 
			
		||||
	if subdomain == "api" {
 | 
			
		||||
		return ""
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// return the reversed subdomain as the namespace, e.g. "staging.foo" => "foo-staging"
 | 
			
		||||
	comps := strings.Split(subdomain, ".")
 | 
			
		||||
	for i := len(comps)/2 - 1; i >= 0; i-- {
 | 
			
		||||
		opp := len(comps) - 1 - i
 | 
			
		||||
		comps[i], comps[opp] = comps[opp], comps[i]
 | 
			
		||||
	}
 | 
			
		||||
	return strings.Join(comps, "-")
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (r *subdomainResolver) String() string {
 | 
			
		||||
	return "subdomain"
 | 
			
		||||
}
 | 
			
		||||
@@ -1,73 +0,0 @@
 | 
			
		||||
package subdomain
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"net/http"
 | 
			
		||||
	"net/url"
 | 
			
		||||
	"testing"
 | 
			
		||||
 | 
			
		||||
	"github.com/unistack-org/micro/v3/api/resolver/vpath"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
func TestResolve(t *testing.T) {
 | 
			
		||||
	tt := []struct {
 | 
			
		||||
		Name   string
 | 
			
		||||
		Host   string
 | 
			
		||||
		Result string
 | 
			
		||||
	}{
 | 
			
		||||
		{
 | 
			
		||||
			Name:   "Top level domain",
 | 
			
		||||
			Host:   "micro.mu",
 | 
			
		||||
			Result: "micro",
 | 
			
		||||
		},
 | 
			
		||||
		{
 | 
			
		||||
			Name:   "Effective top level domain",
 | 
			
		||||
			Host:   "micro.com.au",
 | 
			
		||||
			Result: "micro",
 | 
			
		||||
		},
 | 
			
		||||
		{
 | 
			
		||||
			Name:   "Subdomain dev",
 | 
			
		||||
			Host:   "dev.micro.mu",
 | 
			
		||||
			Result: "dev",
 | 
			
		||||
		},
 | 
			
		||||
		{
 | 
			
		||||
			Name:   "Subdomain foo",
 | 
			
		||||
			Host:   "foo.micro.mu",
 | 
			
		||||
			Result: "foo",
 | 
			
		||||
		},
 | 
			
		||||
		{
 | 
			
		||||
			Name:   "Multi-level subdomain",
 | 
			
		||||
			Host:   "staging.myapp.m3o.app",
 | 
			
		||||
			Result: "myapp-staging",
 | 
			
		||||
		},
 | 
			
		||||
		{
 | 
			
		||||
			Name:   "Dev host",
 | 
			
		||||
			Host:   "127.0.0.1",
 | 
			
		||||
			Result: "micro",
 | 
			
		||||
		},
 | 
			
		||||
		{
 | 
			
		||||
			Name:   "Localhost",
 | 
			
		||||
			Host:   "localhost",
 | 
			
		||||
			Result: "micro",
 | 
			
		||||
		},
 | 
			
		||||
		{
 | 
			
		||||
			Name:   "IP host",
 | 
			
		||||
			Host:   "81.151.101.146",
 | 
			
		||||
			Result: "micro",
 | 
			
		||||
		},
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	for _, tc := range tt {
 | 
			
		||||
		t.Run(tc.Name, func(t *testing.T) {
 | 
			
		||||
			r := NewResolver(vpath.NewResolver())
 | 
			
		||||
			result, err := r.Resolve(&http.Request{URL: &url.URL{Host: tc.Host, Path: "foo/bar"}})
 | 
			
		||||
			if err != nil {
 | 
			
		||||
				t.Fatal(err)
 | 
			
		||||
			}
 | 
			
		||||
			if result != nil {
 | 
			
		||||
				if tc.Result != result.Domain {
 | 
			
		||||
					t.Fatalf("Expected %v but got %v", tc.Result, result.Domain)
 | 
			
		||||
				}
 | 
			
		||||
			}
 | 
			
		||||
		})
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
@@ -1,77 +0,0 @@
 | 
			
		||||
// Package vpath resolves using http path and recognised versioned urls
 | 
			
		||||
package vpath
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"errors"
 | 
			
		||||
	"net/http"
 | 
			
		||||
	"regexp"
 | 
			
		||||
	"strings"
 | 
			
		||||
 | 
			
		||||
	"github.com/unistack-org/micro/v3/api/resolver"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// NewResolver creates new vpath api resolver
 | 
			
		||||
func NewResolver(opts ...resolver.Option) resolver.Resolver {
 | 
			
		||||
	return &vpathResolver{opts: resolver.NewOptions(opts...)}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
type vpathResolver struct {
 | 
			
		||||
	opts resolver.Options
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
var (
 | 
			
		||||
	re = regexp.MustCompile("^v[0-9]+$")
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Resolve endpoint
 | 
			
		||||
func (r *vpathResolver) Resolve(req *http.Request, opts ...resolver.ResolveOption) (*resolver.Endpoint, error) {
 | 
			
		||||
	if req.URL.Path == "/" {
 | 
			
		||||
		return nil, errors.New("unknown name")
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	options := resolver.NewResolveOptions(opts...)
 | 
			
		||||
 | 
			
		||||
	parts := strings.Split(req.URL.Path[1:], "/")
 | 
			
		||||
	if len(parts) == 1 {
 | 
			
		||||
		return &resolver.Endpoint{
 | 
			
		||||
			Name:   r.withPrefix(parts...),
 | 
			
		||||
			Host:   req.Host,
 | 
			
		||||
			Method: req.Method,
 | 
			
		||||
			Path:   req.URL.Path,
 | 
			
		||||
			Domain: options.Domain,
 | 
			
		||||
		}, nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// /v1/foo
 | 
			
		||||
	if re.MatchString(parts[0]) {
 | 
			
		||||
		return &resolver.Endpoint{
 | 
			
		||||
			Name:   r.withPrefix(parts[0:2]...),
 | 
			
		||||
			Host:   req.Host,
 | 
			
		||||
			Method: req.Method,
 | 
			
		||||
			Path:   req.URL.Path,
 | 
			
		||||
			Domain: options.Domain,
 | 
			
		||||
		}, nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return &resolver.Endpoint{
 | 
			
		||||
		Name:   r.withPrefix(parts[0]),
 | 
			
		||||
		Host:   req.Host,
 | 
			
		||||
		Method: req.Method,
 | 
			
		||||
		Path:   req.URL.Path,
 | 
			
		||||
		Domain: options.Domain,
 | 
			
		||||
	}, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (r *vpathResolver) String() string {
 | 
			
		||||
	return "vpath"
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// withPrefix transforms "foo" into "go.micro.api.foo"
 | 
			
		||||
func (r *vpathResolver) withPrefix(parts ...string) string {
 | 
			
		||||
	p := r.opts.ServicePrefix
 | 
			
		||||
	if len(p) > 0 {
 | 
			
		||||
		parts = append([]string{p}, parts...)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return strings.Join(parts, ".")
 | 
			
		||||
}
 | 
			
		||||
@@ -1,70 +0,0 @@
 | 
			
		||||
package router
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
 | 
			
		||||
	"github.com/unistack-org/micro/v3/api/resolver"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/api/resolver/vpath"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/logger"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/register"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Options holds the options for api router
 | 
			
		||||
type Options struct {
 | 
			
		||||
	Handler  string
 | 
			
		||||
	Register register.Register
 | 
			
		||||
	Resolver resolver.Resolver
 | 
			
		||||
	Logger   logger.Logger
 | 
			
		||||
	Context  context.Context
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Option func signature
 | 
			
		||||
type Option func(o *Options)
 | 
			
		||||
 | 
			
		||||
// NewOptions returns options struct filled by opts
 | 
			
		||||
func NewOptions(opts ...Option) Options {
 | 
			
		||||
	options := Options{
 | 
			
		||||
		Context: context.Background(),
 | 
			
		||||
		Handler: "meta",
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	for _, o := range opts {
 | 
			
		||||
		o(&options)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if options.Resolver == nil {
 | 
			
		||||
		options.Resolver = vpath.NewResolver(
 | 
			
		||||
			resolver.WithHandler(options.Handler),
 | 
			
		||||
		)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return options
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithContext sets the context
 | 
			
		||||
func WithContext(ctx context.Context) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.Context = ctx
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithHandler sets the handler
 | 
			
		||||
func WithHandler(h string) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.Handler = h
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithRegister sets the register
 | 
			
		||||
func WithRegister(r register.Register) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.Register = r
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithResolver sets the resolver
 | 
			
		||||
func WithResolver(r resolver.Resolver) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.Resolver = r
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
@@ -1,33 +0,0 @@
 | 
			
		||||
// Package router provides api service routing
 | 
			
		||||
package router
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"net/http"
 | 
			
		||||
 | 
			
		||||
	"github.com/unistack-org/micro/v3/api"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
var (
 | 
			
		||||
	// DefaultRouter contains default router implementation
 | 
			
		||||
	DefaultRouter Router
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Router is used to determine an endpoint for a request
 | 
			
		||||
type Router interface {
 | 
			
		||||
	// Returns options
 | 
			
		||||
	Options() Options
 | 
			
		||||
	// Init initialize router
 | 
			
		||||
	Init(...Option) error
 | 
			
		||||
	// Stop the router
 | 
			
		||||
	Close() error
 | 
			
		||||
	// Endpoint returns an api.Service endpoint or an error if it does not exist
 | 
			
		||||
	Endpoint(r *http.Request) (*api.Service, error)
 | 
			
		||||
	// Register endpoint in router
 | 
			
		||||
	Register(ep *api.Endpoint) error
 | 
			
		||||
	// Deregister endpoint from router
 | 
			
		||||
	Deregister(ep *api.Endpoint) error
 | 
			
		||||
	// Route returns an api.Service route
 | 
			
		||||
	Route(r *http.Request) (*api.Service, error)
 | 
			
		||||
	// String representation of router
 | 
			
		||||
	String() string
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										143
									
								
								auth/auth.go
									
									
									
									
									
								
							
							
						
						
									
										143
									
								
								auth/auth.go
									
									
									
									
									
								
							@@ -1,143 +0,0 @@
 | 
			
		||||
// Package auth provides authentication and authorization capability
 | 
			
		||||
package auth
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"errors"
 | 
			
		||||
	"time"
 | 
			
		||||
 | 
			
		||||
	"github.com/unistack-org/micro/v3/metadata"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
const (
 | 
			
		||||
	// BearerScheme used for Authorization header
 | 
			
		||||
	BearerScheme = "Bearer "
 | 
			
		||||
	// ScopePublic is the scope applied to a rule to allow access to the public
 | 
			
		||||
	ScopePublic = ""
 | 
			
		||||
	// ScopeAccount is the scope applied to a rule to limit to users with any valid account
 | 
			
		||||
	ScopeAccount = "*"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
var (
 | 
			
		||||
	// DefaultAuth holds default auth implementation
 | 
			
		||||
	DefaultAuth Auth = NewAuth()
 | 
			
		||||
	// ErrInvalidToken is when the token provided is not valid
 | 
			
		||||
	ErrInvalidToken = errors.New("invalid token provided")
 | 
			
		||||
	// ErrForbidden is when a user does not have the necessary scope to access a resource
 | 
			
		||||
	ErrForbidden = errors.New("resource forbidden")
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Auth provides authentication and authorization
 | 
			
		||||
type Auth interface {
 | 
			
		||||
	// Init the auth
 | 
			
		||||
	Init(opts ...Option)
 | 
			
		||||
	// Options set for auth
 | 
			
		||||
	Options() Options
 | 
			
		||||
	// Generate a new account
 | 
			
		||||
	Generate(id string, opts ...GenerateOption) (*Account, error)
 | 
			
		||||
	// Verify an account has access to a resource using the rules
 | 
			
		||||
	Verify(acc *Account, res *Resource, opts ...VerifyOption) error
 | 
			
		||||
	// Inspect a token
 | 
			
		||||
	Inspect(token string) (*Account, error)
 | 
			
		||||
	// Token generated using refresh token or credentials
 | 
			
		||||
	Token(opts ...TokenOption) (*Token, error)
 | 
			
		||||
	// Grant access to a resource
 | 
			
		||||
	Grant(rule *Rule) error
 | 
			
		||||
	// Revoke access to a resource
 | 
			
		||||
	Revoke(rule *Rule) error
 | 
			
		||||
	// Rules returns all the rules used to verify requests
 | 
			
		||||
	Rules(...RulesOption) ([]*Rule, error)
 | 
			
		||||
	// String returns the name of the implementation
 | 
			
		||||
	String() string
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Account provided by an auth provider
 | 
			
		||||
type Account struct {
 | 
			
		||||
	// ID of the account e.g. email
 | 
			
		||||
	ID string `json:"id"`
 | 
			
		||||
	// Type of the account, e.g. service
 | 
			
		||||
	Type string `json:"type"`
 | 
			
		||||
	// Issuer of the account
 | 
			
		||||
	Issuer string `json:"issuer"`
 | 
			
		||||
	// Any other associated metadata
 | 
			
		||||
	Metadata metadata.Metadata `json:"metadata"`
 | 
			
		||||
	// Scopes the account has access to
 | 
			
		||||
	Scopes []string `json:"scopes"`
 | 
			
		||||
	// Secret for the account, e.g. the password
 | 
			
		||||
	Secret string `json:"secret"`
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Token can be short or long lived
 | 
			
		||||
type Token struct {
 | 
			
		||||
	// The token to be used for accessing resources
 | 
			
		||||
	AccessToken string `json:"access_token"`
 | 
			
		||||
	// RefreshToken to be used to generate a new token
 | 
			
		||||
	RefreshToken string `json:"refresh_token"`
 | 
			
		||||
	// Time of token creation
 | 
			
		||||
	Created time.Time `json:"created"`
 | 
			
		||||
	// Time of token expiry
 | 
			
		||||
	Expiry time.Time `json:"expiry"`
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Expired returns a boolean indicating if the token needs to be refreshed
 | 
			
		||||
func (t *Token) Expired() bool {
 | 
			
		||||
	return t.Expiry.Unix() < time.Now().Unix()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Resource is an entity such as a user or
 | 
			
		||||
type Resource struct {
 | 
			
		||||
	// Name of the resource, e.g. go.micro.service.notes
 | 
			
		||||
	Name string `json:"name"`
 | 
			
		||||
	// Type of resource, e.g. service
 | 
			
		||||
	Type string `json:"type"`
 | 
			
		||||
	// Endpoint resource e.g NotesService.Create
 | 
			
		||||
	Endpoint string `json:"endpoint"`
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Access defines the type of access a rule grants
 | 
			
		||||
type Access int
 | 
			
		||||
 | 
			
		||||
const (
 | 
			
		||||
	// AccessGranted to a resource
 | 
			
		||||
	AccessGranted Access = iota
 | 
			
		||||
	// AccessDenied to a resource
 | 
			
		||||
	AccessDenied
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Rule is used to verify access to a resource
 | 
			
		||||
type Rule struct {
 | 
			
		||||
	// ID of the rule, e.g. "public"
 | 
			
		||||
	ID string
 | 
			
		||||
	// Scope the rule requires, a blank scope indicates open to the public and * indicates the rule
 | 
			
		||||
	// applies to any valid account
 | 
			
		||||
	Scope string
 | 
			
		||||
	// Resource the rule applies to
 | 
			
		||||
	Resource *Resource
 | 
			
		||||
	// Access determines if the rule grants or denies access to the resource
 | 
			
		||||
	Access Access
 | 
			
		||||
	// Priority the rule should take when verifying a request, the higher the value the sooner the
 | 
			
		||||
	// rule will be applied
 | 
			
		||||
	Priority int32
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
type accountKey struct{}
 | 
			
		||||
 | 
			
		||||
// AccountFromContext gets the account from the context, which
 | 
			
		||||
// is set by the auth wrapper at the start of a call. If the account
 | 
			
		||||
// is not set, a nil account will be returned. The error is only returned
 | 
			
		||||
// when there was a problem retrieving an account
 | 
			
		||||
func AccountFromContext(ctx context.Context) (*Account, bool) {
 | 
			
		||||
	if ctx == nil {
 | 
			
		||||
		return nil, false
 | 
			
		||||
	}
 | 
			
		||||
	acc, ok := ctx.Value(accountKey{}).(*Account)
 | 
			
		||||
	return acc, ok
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// ContextWithAccount sets the account in the context
 | 
			
		||||
func ContextWithAccount(ctx context.Context, account *Account) context.Context {
 | 
			
		||||
	if ctx == nil {
 | 
			
		||||
		ctx = context.Background()
 | 
			
		||||
	}
 | 
			
		||||
	return context.WithValue(ctx, accountKey{}, account)
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										78
									
								
								auth/noop.go
									
									
									
									
									
								
							
							
						
						
									
										78
									
								
								auth/noop.go
									
									
									
									
									
								
							@@ -1,78 +0,0 @@
 | 
			
		||||
package auth
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"github.com/google/uuid"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
type noopAuth struct {
 | 
			
		||||
	opts Options
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// String returns the name of the implementation
 | 
			
		||||
func (n *noopAuth) String() string {
 | 
			
		||||
	return "noop"
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Init the auth
 | 
			
		||||
func (n *noopAuth) Init(opts ...Option) {
 | 
			
		||||
	for _, o := range opts {
 | 
			
		||||
		o(&n.opts)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Options set for auth
 | 
			
		||||
func (n *noopAuth) Options() Options {
 | 
			
		||||
	return n.opts
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Generate a new account
 | 
			
		||||
func (n *noopAuth) Generate(id string, opts ...GenerateOption) (*Account, error) {
 | 
			
		||||
	options := NewGenerateOptions(opts...)
 | 
			
		||||
 | 
			
		||||
	return &Account{
 | 
			
		||||
		ID:       id,
 | 
			
		||||
		Secret:   options.Secret,
 | 
			
		||||
		Metadata: options.Metadata,
 | 
			
		||||
		Scopes:   options.Scopes,
 | 
			
		||||
		Issuer:   n.Options().Issuer,
 | 
			
		||||
	}, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Grant access to a resource
 | 
			
		||||
func (n *noopAuth) Grant(rule *Rule) error {
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Revoke access to a resource
 | 
			
		||||
func (n *noopAuth) Revoke(rule *Rule) error {
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Rules used to verify requests
 | 
			
		||||
func (n *noopAuth) Rules(opts ...RulesOption) ([]*Rule, error) {
 | 
			
		||||
	return []*Rule{}, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Verify an account has access to a resource
 | 
			
		||||
func (n *noopAuth) Verify(acc *Account, res *Resource, opts ...VerifyOption) error {
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Inspect a token
 | 
			
		||||
func (n *noopAuth) Inspect(token string) (*Account, error) {
 | 
			
		||||
	uid, err := uuid.NewRandom()
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		return nil, err
 | 
			
		||||
	}
 | 
			
		||||
	return &Account{ID: uid.String(), Issuer: n.Options().Issuer}, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Token generation using an account id and secret
 | 
			
		||||
func (n *noopAuth) Token(opts ...TokenOption) (*Token, error) {
 | 
			
		||||
	return &Token{}, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewAuth returns new noop auth
 | 
			
		||||
func NewAuth(opts ...Option) Auth {
 | 
			
		||||
	return &noopAuth{opts: NewOptions(opts...)}
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										321
									
								
								auth/options.go
									
									
									
									
									
								
							
							
						
						
									
										321
									
								
								auth/options.go
									
									
									
									
									
								
							@@ -1,321 +0,0 @@
 | 
			
		||||
package auth
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"time"
 | 
			
		||||
 | 
			
		||||
	"github.com/unistack-org/micro/v3/logger"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/metadata"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/meter"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/store"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/tracer"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// NewOptions creates Options struct from slice of options
 | 
			
		||||
func NewOptions(opts ...Option) Options {
 | 
			
		||||
	options := Options{
 | 
			
		||||
		Tracer: tracer.DefaultTracer,
 | 
			
		||||
		Logger: logger.DefaultLogger,
 | 
			
		||||
		Meter:  meter.DefaultMeter,
 | 
			
		||||
	}
 | 
			
		||||
	for _, o := range opts {
 | 
			
		||||
		o(&options)
 | 
			
		||||
	}
 | 
			
		||||
	return options
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Options struct holds auth options
 | 
			
		||||
type Options struct {
 | 
			
		||||
	Name string
 | 
			
		||||
	// Issuer of the service's account
 | 
			
		||||
	Issuer string
 | 
			
		||||
	// ID is the services auth ID
 | 
			
		||||
	ID string
 | 
			
		||||
	// Secret is used to authenticate the service
 | 
			
		||||
	Secret string
 | 
			
		||||
	// Token is the services token used to authenticate itself
 | 
			
		||||
	Token *Token
 | 
			
		||||
	// PublicKey for decoding JWTs
 | 
			
		||||
	PublicKey string
 | 
			
		||||
	// PrivateKey for encoding JWTs
 | 
			
		||||
	PrivateKey string
 | 
			
		||||
	// LoginURL is the relative url path where a user can login
 | 
			
		||||
	LoginURL string
 | 
			
		||||
	// Store to back auth
 | 
			
		||||
	Store store.Store
 | 
			
		||||
	// Addrs sets the addresses of auth
 | 
			
		||||
	Addrs []string
 | 
			
		||||
	// Logger sets the logger
 | 
			
		||||
	Logger logger.Logger
 | 
			
		||||
	// Meter sets tht meter
 | 
			
		||||
	Meter meter.Meter
 | 
			
		||||
	// Tracer
 | 
			
		||||
	Tracer tracer.Tracer
 | 
			
		||||
	// Context to store other options
 | 
			
		||||
	Context context.Context
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Option func
 | 
			
		||||
type Option func(o *Options)
 | 
			
		||||
 | 
			
		||||
// Addrs is the auth addresses to use
 | 
			
		||||
func Addrs(addrs ...string) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.Addrs = addrs
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Name sets the name
 | 
			
		||||
func Name(n string) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.Name = n
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Issuer of the services account
 | 
			
		||||
func Issuer(i string) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.Issuer = i
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Store to back auth
 | 
			
		||||
func Store(s store.Store) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.Store = s
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// PublicKey is the JWT public key
 | 
			
		||||
func PublicKey(key string) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.PublicKey = key
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// PrivateKey is the JWT private key
 | 
			
		||||
func PrivateKey(key string) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.PrivateKey = key
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Credentials sets the auth credentials
 | 
			
		||||
func Credentials(id, secret string) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.ID = id
 | 
			
		||||
		o.Secret = secret
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// ClientToken sets the auth token to use when making requests
 | 
			
		||||
func ClientToken(token *Token) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.Token = token
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// LoginURL sets the auth LoginURL
 | 
			
		||||
func LoginURL(url string) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.LoginURL = url
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// GenerateOptions struct
 | 
			
		||||
type GenerateOptions struct {
 | 
			
		||||
	// Metadata associated with the account
 | 
			
		||||
	Metadata metadata.Metadata
 | 
			
		||||
	// Scopes the account has access too
 | 
			
		||||
	Scopes []string
 | 
			
		||||
	// Provider of the account, e.g. oauth
 | 
			
		||||
	Provider string
 | 
			
		||||
	// Type of the account, e.g. user
 | 
			
		||||
	Type string
 | 
			
		||||
	// Secret used to authenticate the account
 | 
			
		||||
	Secret string
 | 
			
		||||
	// Issuer of the account, e.g. micro
 | 
			
		||||
	Issuer string
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// GenerateOption func
 | 
			
		||||
type GenerateOption func(o *GenerateOptions)
 | 
			
		||||
 | 
			
		||||
// WithSecret for the generated account
 | 
			
		||||
func WithSecret(s string) GenerateOption {
 | 
			
		||||
	return func(o *GenerateOptions) {
 | 
			
		||||
		o.Secret = s
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithType for the generated account
 | 
			
		||||
func WithType(t string) GenerateOption {
 | 
			
		||||
	return func(o *GenerateOptions) {
 | 
			
		||||
		o.Type = t
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithMetadata for the generated account
 | 
			
		||||
func WithMetadata(md metadata.Metadata) GenerateOption {
 | 
			
		||||
	return func(o *GenerateOptions) {
 | 
			
		||||
		o.Metadata = metadata.Copy(md)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithProvider for the generated account
 | 
			
		||||
func WithProvider(p string) GenerateOption {
 | 
			
		||||
	return func(o *GenerateOptions) {
 | 
			
		||||
		o.Provider = p
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithScopes for the generated account
 | 
			
		||||
func WithScopes(s ...string) GenerateOption {
 | 
			
		||||
	return func(o *GenerateOptions) {
 | 
			
		||||
		o.Scopes = s
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithIssuer for the generated account
 | 
			
		||||
func WithIssuer(i string) GenerateOption {
 | 
			
		||||
	return func(o *GenerateOptions) {
 | 
			
		||||
		o.Issuer = i
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewGenerateOptions from a slice of options
 | 
			
		||||
func NewGenerateOptions(opts ...GenerateOption) GenerateOptions {
 | 
			
		||||
	var options GenerateOptions
 | 
			
		||||
	for _, o := range opts {
 | 
			
		||||
		o(&options)
 | 
			
		||||
	}
 | 
			
		||||
	return options
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// TokenOptions struct
 | 
			
		||||
type TokenOptions struct {
 | 
			
		||||
	// ID for the account
 | 
			
		||||
	ID string
 | 
			
		||||
	// Secret for the account
 | 
			
		||||
	Secret string
 | 
			
		||||
	// RefreshToken is used to refesh a token
 | 
			
		||||
	RefreshToken string
 | 
			
		||||
	// Expiry is the time the token should live for
 | 
			
		||||
	Expiry time.Duration
 | 
			
		||||
	// Issuer of the account
 | 
			
		||||
	Issuer string
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// TokenOption func
 | 
			
		||||
type TokenOption func(o *TokenOptions)
 | 
			
		||||
 | 
			
		||||
// WithExpiry for the token
 | 
			
		||||
func WithExpiry(ex time.Duration) TokenOption {
 | 
			
		||||
	return func(o *TokenOptions) {
 | 
			
		||||
		o.Expiry = ex
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithCredentials sets tye id and secret
 | 
			
		||||
func WithCredentials(id, secret string) TokenOption {
 | 
			
		||||
	return func(o *TokenOptions) {
 | 
			
		||||
		o.ID = id
 | 
			
		||||
		o.Secret = secret
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithToken sets the refresh token
 | 
			
		||||
func WithToken(rt string) TokenOption {
 | 
			
		||||
	return func(o *TokenOptions) {
 | 
			
		||||
		o.RefreshToken = rt
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithTokenIssuer sets the token issuer option
 | 
			
		||||
func WithTokenIssuer(iss string) TokenOption {
 | 
			
		||||
	return func(o *TokenOptions) {
 | 
			
		||||
		o.Issuer = iss
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewTokenOptions from a slice of options
 | 
			
		||||
func NewTokenOptions(opts ...TokenOption) TokenOptions {
 | 
			
		||||
	var options TokenOptions
 | 
			
		||||
	for _, o := range opts {
 | 
			
		||||
		o(&options)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// set default expiry of token
 | 
			
		||||
	if options.Expiry == 0 {
 | 
			
		||||
		options.Expiry = time.Minute
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return options
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// VerifyOptions struct
 | 
			
		||||
type VerifyOptions struct {
 | 
			
		||||
	Context   context.Context
 | 
			
		||||
	Namespace string
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// VerifyOption func
 | 
			
		||||
type VerifyOption func(o *VerifyOptions)
 | 
			
		||||
 | 
			
		||||
// VerifyContext pass context to verify
 | 
			
		||||
func VerifyContext(ctx context.Context) VerifyOption {
 | 
			
		||||
	return func(o *VerifyOptions) {
 | 
			
		||||
		o.Context = ctx
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// VerifyNamespace sets thhe namespace for verify
 | 
			
		||||
func VerifyNamespace(ns string) VerifyOption {
 | 
			
		||||
	return func(o *VerifyOptions) {
 | 
			
		||||
		o.Namespace = ns
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// RulesOptions struct
 | 
			
		||||
type RulesOptions struct {
 | 
			
		||||
	Context   context.Context
 | 
			
		||||
	Namespace string
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// RulesOption func
 | 
			
		||||
type RulesOption func(o *RulesOptions)
 | 
			
		||||
 | 
			
		||||
// RulesContext pass rules context
 | 
			
		||||
func RulesContext(ctx context.Context) RulesOption {
 | 
			
		||||
	return func(o *RulesOptions) {
 | 
			
		||||
		o.Context = ctx
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// RulesNamespace sets the rule namespace
 | 
			
		||||
func RulesNamespace(ns string) RulesOption {
 | 
			
		||||
	return func(o *RulesOptions) {
 | 
			
		||||
		o.Namespace = ns
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Logger sets the logger
 | 
			
		||||
func Logger(l logger.Logger) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.Logger = l
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Meter sets the meter
 | 
			
		||||
func Meter(m meter.Meter) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.Meter = m
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Tracer sets the meter
 | 
			
		||||
func Tracer(t tracer.Tracer) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.Tracer = t
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
@@ -1,92 +0,0 @@
 | 
			
		||||
package auth
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"fmt"
 | 
			
		||||
	"sort"
 | 
			
		||||
	"strings"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// VerifyAccess an account has access to a resource using the rules provided. If the account does not have
 | 
			
		||||
// access an error will be returned. If there are no rules provided which match the resource, an error
 | 
			
		||||
// will be returned
 | 
			
		||||
//nolint:gocyclo
 | 
			
		||||
func VerifyAccess(rules []*Rule, acc *Account, res *Resource) error {
 | 
			
		||||
	// the rule is only to be applied if the type matches the resource or is catch-all (*)
 | 
			
		||||
	validTypes := []string{"*", res.Type}
 | 
			
		||||
 | 
			
		||||
	// the rule is only to be applied if the name matches the resource or is catch-all (*)
 | 
			
		||||
	validNames := []string{"*", res.Name}
 | 
			
		||||
 | 
			
		||||
	// rules can have wildcard excludes on endpoints since this can also be a path for web services,
 | 
			
		||||
	// e.g. /foo/* would include /foo/bar. We also want to check for wildcards and the exact endpoint
 | 
			
		||||
	validEndpoints := []string{"*", res.Endpoint}
 | 
			
		||||
	if comps := strings.Split(res.Endpoint, "/"); len(comps) > 1 {
 | 
			
		||||
		for i := 1; i < len(comps)+1; i++ {
 | 
			
		||||
			wildcard := fmt.Sprintf("%v/*", strings.Join(comps[0:i], "/"))
 | 
			
		||||
			validEndpoints = append(validEndpoints, wildcard)
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// filter the rules to the ones which match the criteria above
 | 
			
		||||
	filteredRules := make([]*Rule, 0)
 | 
			
		||||
	for _, rule := range rules {
 | 
			
		||||
		if !include(validTypes, rule.Resource.Type) {
 | 
			
		||||
			continue
 | 
			
		||||
		}
 | 
			
		||||
		if !include(validNames, rule.Resource.Name) {
 | 
			
		||||
			continue
 | 
			
		||||
		}
 | 
			
		||||
		if !include(validEndpoints, rule.Resource.Endpoint) {
 | 
			
		||||
			continue
 | 
			
		||||
		}
 | 
			
		||||
		filteredRules = append(filteredRules, rule)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// sort the filtered rules by priority, highest to lowest
 | 
			
		||||
	sort.SliceStable(filteredRules, func(i, j int) bool {
 | 
			
		||||
		return filteredRules[i].Priority > filteredRules[j].Priority
 | 
			
		||||
	})
 | 
			
		||||
 | 
			
		||||
	// loop through the rules and check for a rule which applies to this account
 | 
			
		||||
	for _, rule := range filteredRules {
 | 
			
		||||
		// a blank scope indicates the rule applies to everyone, even nil accounts
 | 
			
		||||
		if rule.Scope == ScopePublic && rule.Access == AccessDenied {
 | 
			
		||||
			return ErrForbidden
 | 
			
		||||
		} else if rule.Scope == ScopePublic && rule.Access == AccessGranted {
 | 
			
		||||
			return nil
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		// all further checks require an account
 | 
			
		||||
		if acc == nil {
 | 
			
		||||
			continue
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		// this rule applies to any account
 | 
			
		||||
		if rule.Scope == ScopeAccount && rule.Access == AccessDenied {
 | 
			
		||||
			return ErrForbidden
 | 
			
		||||
		} else if rule.Scope == ScopeAccount && rule.Access == AccessGranted {
 | 
			
		||||
			return nil
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		// if the account has the necessary scope
 | 
			
		||||
		if include(acc.Scopes, rule.Scope) && rule.Access == AccessDenied {
 | 
			
		||||
			return ErrForbidden
 | 
			
		||||
		} else if include(acc.Scopes, rule.Scope) && rule.Access == AccessGranted {
 | 
			
		||||
			return nil
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// if no rules matched then return forbidden
 | 
			
		||||
	return ErrForbidden
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// include is a helper function which checks to see if the slice contains the value. includes is
 | 
			
		||||
// not case sensitive.
 | 
			
		||||
func include(slice []string, val string) bool {
 | 
			
		||||
	for _, s := range slice {
 | 
			
		||||
		if strings.EqualFold(s, val) {
 | 
			
		||||
			return true
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
	return false
 | 
			
		||||
}
 | 
			
		||||
@@ -1,288 +0,0 @@
 | 
			
		||||
package auth
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"testing"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
func TestVerify(t *testing.T) {
 | 
			
		||||
	srvResource := &Resource{
 | 
			
		||||
		Type:     "service",
 | 
			
		||||
		Name:     "go.micro.service.foo",
 | 
			
		||||
		Endpoint: "Foo.Bar",
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	webResource := &Resource{
 | 
			
		||||
		Type:     "service",
 | 
			
		||||
		Name:     "go.micro.web.foo",
 | 
			
		||||
		Endpoint: "/foo/bar",
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	catchallResource := &Resource{
 | 
			
		||||
		Type:     "*",
 | 
			
		||||
		Name:     "*",
 | 
			
		||||
		Endpoint: "*",
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	tt := []struct {
 | 
			
		||||
		Name     string
 | 
			
		||||
		Rules    []*Rule
 | 
			
		||||
		Account  *Account
 | 
			
		||||
		Resource *Resource
 | 
			
		||||
		Error    error
 | 
			
		||||
	}{
 | 
			
		||||
		{
 | 
			
		||||
			Name:     "NoRules",
 | 
			
		||||
			Rules:    []*Rule{},
 | 
			
		||||
			Account:  nil,
 | 
			
		||||
			Resource: srvResource,
 | 
			
		||||
			Error:    ErrForbidden,
 | 
			
		||||
		},
 | 
			
		||||
		{
 | 
			
		||||
			Name:     "CatchallPublicAccount",
 | 
			
		||||
			Account:  &Account{},
 | 
			
		||||
			Resource: srvResource,
 | 
			
		||||
			Rules: []*Rule{
 | 
			
		||||
				{
 | 
			
		||||
					Scope:    "",
 | 
			
		||||
					Resource: catchallResource,
 | 
			
		||||
				},
 | 
			
		||||
			},
 | 
			
		||||
		},
 | 
			
		||||
		{
 | 
			
		||||
			Name:     "CatchallPublicNoAccount",
 | 
			
		||||
			Resource: srvResource,
 | 
			
		||||
			Rules: []*Rule{
 | 
			
		||||
				{
 | 
			
		||||
					Scope:    "",
 | 
			
		||||
					Resource: catchallResource,
 | 
			
		||||
				},
 | 
			
		||||
			},
 | 
			
		||||
		},
 | 
			
		||||
		{
 | 
			
		||||
			Name:     "CatchallPrivateAccount",
 | 
			
		||||
			Account:  &Account{},
 | 
			
		||||
			Resource: srvResource,
 | 
			
		||||
			Rules: []*Rule{
 | 
			
		||||
				{
 | 
			
		||||
					Scope:    "*",
 | 
			
		||||
					Resource: catchallResource,
 | 
			
		||||
				},
 | 
			
		||||
			},
 | 
			
		||||
		},
 | 
			
		||||
		{
 | 
			
		||||
			Name:     "CatchallPrivateNoAccount",
 | 
			
		||||
			Resource: srvResource,
 | 
			
		||||
			Rules: []*Rule{
 | 
			
		||||
				{
 | 
			
		||||
					Scope:    "*",
 | 
			
		||||
					Resource: catchallResource,
 | 
			
		||||
				},
 | 
			
		||||
			},
 | 
			
		||||
			Error: ErrForbidden,
 | 
			
		||||
		},
 | 
			
		||||
		{
 | 
			
		||||
			Name:     "CatchallServiceRuleMatch",
 | 
			
		||||
			Resource: srvResource,
 | 
			
		||||
			Account:  &Account{},
 | 
			
		||||
			Rules: []*Rule{
 | 
			
		||||
				{
 | 
			
		||||
					Scope: "*",
 | 
			
		||||
					Resource: &Resource{
 | 
			
		||||
						Type:     srvResource.Type,
 | 
			
		||||
						Name:     srvResource.Name,
 | 
			
		||||
						Endpoint: "*",
 | 
			
		||||
					},
 | 
			
		||||
				},
 | 
			
		||||
			},
 | 
			
		||||
		},
 | 
			
		||||
		{
 | 
			
		||||
			Name:     "CatchallServiceRuleNoMatch",
 | 
			
		||||
			Resource: srvResource,
 | 
			
		||||
			Account:  &Account{},
 | 
			
		||||
			Rules: []*Rule{
 | 
			
		||||
				{
 | 
			
		||||
					Scope: "*",
 | 
			
		||||
					Resource: &Resource{
 | 
			
		||||
						Type:     srvResource.Type,
 | 
			
		||||
						Name:     "wrongname",
 | 
			
		||||
						Endpoint: "*",
 | 
			
		||||
					},
 | 
			
		||||
				},
 | 
			
		||||
			},
 | 
			
		||||
			Error: ErrForbidden,
 | 
			
		||||
		},
 | 
			
		||||
		{
 | 
			
		||||
			Name:     "ExactRuleValidScope",
 | 
			
		||||
			Resource: srvResource,
 | 
			
		||||
			Account: &Account{
 | 
			
		||||
				Scopes: []string{"neededscope"},
 | 
			
		||||
			},
 | 
			
		||||
			Rules: []*Rule{
 | 
			
		||||
				{
 | 
			
		||||
					Scope:    "neededscope",
 | 
			
		||||
					Resource: srvResource,
 | 
			
		||||
				},
 | 
			
		||||
			},
 | 
			
		||||
		},
 | 
			
		||||
		{
 | 
			
		||||
			Name:     "ExactRuleInvalidScope",
 | 
			
		||||
			Resource: srvResource,
 | 
			
		||||
			Account: &Account{
 | 
			
		||||
				Scopes: []string{"neededscope"},
 | 
			
		||||
			},
 | 
			
		||||
			Rules: []*Rule{
 | 
			
		||||
				{
 | 
			
		||||
					Scope:    "invalidscope",
 | 
			
		||||
					Resource: srvResource,
 | 
			
		||||
				},
 | 
			
		||||
			},
 | 
			
		||||
			Error: ErrForbidden,
 | 
			
		||||
		},
 | 
			
		||||
		{
 | 
			
		||||
			Name:     "CatchallDenyWithAccount",
 | 
			
		||||
			Resource: srvResource,
 | 
			
		||||
			Account:  &Account{},
 | 
			
		||||
			Rules: []*Rule{
 | 
			
		||||
				{
 | 
			
		||||
					Scope:    "*",
 | 
			
		||||
					Resource: catchallResource,
 | 
			
		||||
					Access:   AccessDenied,
 | 
			
		||||
				},
 | 
			
		||||
			},
 | 
			
		||||
			Error: ErrForbidden,
 | 
			
		||||
		},
 | 
			
		||||
		{
 | 
			
		||||
			Name:     "CatchallDenyWithNoAccount",
 | 
			
		||||
			Resource: srvResource,
 | 
			
		||||
			Account:  &Account{},
 | 
			
		||||
			Rules: []*Rule{
 | 
			
		||||
				{
 | 
			
		||||
					Scope:    "*",
 | 
			
		||||
					Resource: catchallResource,
 | 
			
		||||
					Access:   AccessDenied,
 | 
			
		||||
				},
 | 
			
		||||
			},
 | 
			
		||||
			Error: ErrForbidden,
 | 
			
		||||
		},
 | 
			
		||||
		{
 | 
			
		||||
			Name:     "RulePriorityGrantFirst",
 | 
			
		||||
			Resource: srvResource,
 | 
			
		||||
			Account:  &Account{},
 | 
			
		||||
			Rules: []*Rule{
 | 
			
		||||
				{
 | 
			
		||||
					Scope:    "*",
 | 
			
		||||
					Resource: catchallResource,
 | 
			
		||||
					Access:   AccessGranted,
 | 
			
		||||
					Priority: 1,
 | 
			
		||||
				},
 | 
			
		||||
				{
 | 
			
		||||
					Scope:    "*",
 | 
			
		||||
					Resource: catchallResource,
 | 
			
		||||
					Access:   AccessDenied,
 | 
			
		||||
					Priority: 0,
 | 
			
		||||
				},
 | 
			
		||||
			},
 | 
			
		||||
		},
 | 
			
		||||
		{
 | 
			
		||||
			Name:     "RulePriorityDenyFirst",
 | 
			
		||||
			Resource: srvResource,
 | 
			
		||||
			Account:  &Account{},
 | 
			
		||||
			Rules: []*Rule{
 | 
			
		||||
				{
 | 
			
		||||
					Scope:    "*",
 | 
			
		||||
					Resource: catchallResource,
 | 
			
		||||
					Access:   AccessGranted,
 | 
			
		||||
					Priority: 0,
 | 
			
		||||
				},
 | 
			
		||||
				{
 | 
			
		||||
					Scope:    "*",
 | 
			
		||||
					Resource: catchallResource,
 | 
			
		||||
					Access:   AccessDenied,
 | 
			
		||||
					Priority: 1,
 | 
			
		||||
				},
 | 
			
		||||
			},
 | 
			
		||||
			Error: ErrForbidden,
 | 
			
		||||
		},
 | 
			
		||||
		{
 | 
			
		||||
			Name:     "WebExactEndpointValid",
 | 
			
		||||
			Resource: webResource,
 | 
			
		||||
			Account:  &Account{},
 | 
			
		||||
			Rules: []*Rule{
 | 
			
		||||
				{
 | 
			
		||||
					Scope:    "*",
 | 
			
		||||
					Resource: webResource,
 | 
			
		||||
				},
 | 
			
		||||
			},
 | 
			
		||||
		},
 | 
			
		||||
		{
 | 
			
		||||
			Name:     "WebExactEndpointInalid",
 | 
			
		||||
			Resource: webResource,
 | 
			
		||||
			Account:  &Account{},
 | 
			
		||||
			Rules: []*Rule{
 | 
			
		||||
				{
 | 
			
		||||
					Scope: "*",
 | 
			
		||||
					Resource: &Resource{
 | 
			
		||||
						Type:     webResource.Type,
 | 
			
		||||
						Name:     webResource.Name,
 | 
			
		||||
						Endpoint: "invalidendpoint",
 | 
			
		||||
					},
 | 
			
		||||
				},
 | 
			
		||||
			},
 | 
			
		||||
			Error: ErrForbidden,
 | 
			
		||||
		},
 | 
			
		||||
		{
 | 
			
		||||
			Name:     "WebWildcardEndpoint",
 | 
			
		||||
			Resource: webResource,
 | 
			
		||||
			Account:  &Account{},
 | 
			
		||||
			Rules: []*Rule{
 | 
			
		||||
				{
 | 
			
		||||
					Scope: "*",
 | 
			
		||||
					Resource: &Resource{
 | 
			
		||||
						Type:     webResource.Type,
 | 
			
		||||
						Name:     webResource.Name,
 | 
			
		||||
						Endpoint: "*",
 | 
			
		||||
					},
 | 
			
		||||
				},
 | 
			
		||||
			},
 | 
			
		||||
		},
 | 
			
		||||
		{
 | 
			
		||||
			Name:     "WebWildcardPathEndpointValid",
 | 
			
		||||
			Resource: webResource,
 | 
			
		||||
			Account:  &Account{},
 | 
			
		||||
			Rules: []*Rule{
 | 
			
		||||
				{
 | 
			
		||||
					Scope: "*",
 | 
			
		||||
					Resource: &Resource{
 | 
			
		||||
						Type:     webResource.Type,
 | 
			
		||||
						Name:     webResource.Name,
 | 
			
		||||
						Endpoint: "/foo/*",
 | 
			
		||||
					},
 | 
			
		||||
				},
 | 
			
		||||
			},
 | 
			
		||||
		},
 | 
			
		||||
		{
 | 
			
		||||
			Name:     "WebWildcardPathEndpointInvalid",
 | 
			
		||||
			Resource: webResource,
 | 
			
		||||
			Account:  &Account{},
 | 
			
		||||
			Rules: []*Rule{
 | 
			
		||||
				{
 | 
			
		||||
					Scope: "*",
 | 
			
		||||
					Resource: &Resource{
 | 
			
		||||
						Type:     webResource.Type,
 | 
			
		||||
						Name:     webResource.Name,
 | 
			
		||||
						Endpoint: "/bar/*",
 | 
			
		||||
					},
 | 
			
		||||
				},
 | 
			
		||||
			},
 | 
			
		||||
			Error: ErrForbidden,
 | 
			
		||||
		},
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	for _, tc := range tt {
 | 
			
		||||
		t.Run(tc.Name, func(t *testing.T) {
 | 
			
		||||
			if err := VerifyAccess(tc.Rules, tc.Account, tc.Resource); err != tc.Error {
 | 
			
		||||
				t.Errorf("Expected %v but got %v", tc.Error, err)
 | 
			
		||||
			}
 | 
			
		||||
		})
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
@@ -3,48 +3,89 @@ package broker
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"errors"
 | 
			
		||||
	"time"
 | 
			
		||||
 | 
			
		||||
	"github.com/unistack-org/micro/v3/metadata"
 | 
			
		||||
	"go.unistack.org/micro/v4/codec"
 | 
			
		||||
	"go.unistack.org/micro/v4/metadata"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// DefaultBroker default memory broker
 | 
			
		||||
var DefaultBroker Broker = NewBroker()
 | 
			
		||||
 | 
			
		||||
var (
 | 
			
		||||
	// DefaultBroker default broker
 | 
			
		||||
	DefaultBroker Broker = NewBroker()
 | 
			
		||||
	// ErrNotConnected returns when broker used but not connected yet
 | 
			
		||||
	ErrNotConnected = errors.New("broker not connected")
 | 
			
		||||
	// ErrDisconnected returns when broker disconnected
 | 
			
		||||
	ErrDisconnected = errors.New("broker disconnected")
 | 
			
		||||
	// ErrInvalidMessage returns when invalid Message passed
 | 
			
		||||
	ErrInvalidMessage = errors.New("invalid message")
 | 
			
		||||
	// ErrInvalidHandler returns when subscriber passed to Subscribe
 | 
			
		||||
	ErrInvalidHandler = errors.New("invalid handler, ony func(Message) error and func([]Message) error supported")
 | 
			
		||||
	// DefaultGracefulTimeout
 | 
			
		||||
	DefaultGracefulTimeout = 5 * time.Second
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Broker is an interface used for asynchronous messaging.
 | 
			
		||||
type Broker interface {
 | 
			
		||||
	// Name returns broker instance name
 | 
			
		||||
	Name() string
 | 
			
		||||
	Init(...Option) error
 | 
			
		||||
	// Init initilize broker
 | 
			
		||||
	Init(opts ...Option) error
 | 
			
		||||
	// Options returns broker options
 | 
			
		||||
	Options() Options
 | 
			
		||||
	// Address return configured address
 | 
			
		||||
	Address() string
 | 
			
		||||
	Connect(context.Context) error
 | 
			
		||||
	Disconnect(context.Context) error
 | 
			
		||||
	Publish(context.Context, string, *Message, ...PublishOption) error
 | 
			
		||||
	Subscribe(context.Context, string, Handler, ...SubscribeOption) (Subscriber, error)
 | 
			
		||||
	// Connect connects to broker
 | 
			
		||||
	Connect(ctx context.Context) error
 | 
			
		||||
	// Disconnect disconnect from broker
 | 
			
		||||
	Disconnect(ctx context.Context) error
 | 
			
		||||
	// NewMessage create new broker message to publish.
 | 
			
		||||
	NewMessage(ctx context.Context, hdr metadata.Metadata, body interface{}, opts ...PublishOption) (Message, error)
 | 
			
		||||
	// Publish message to broker topic
 | 
			
		||||
	Publish(ctx context.Context, topic string, messages ...Message) error
 | 
			
		||||
	// Subscribe subscribes to topic message via handler
 | 
			
		||||
	Subscribe(ctx context.Context, topic string, handler interface{}, opts ...SubscribeOption) (Subscriber, error)
 | 
			
		||||
	// String type of broker
 | 
			
		||||
	String() string
 | 
			
		||||
	// Live returns broker liveness
 | 
			
		||||
	Live() bool
 | 
			
		||||
	// Ready returns broker readiness
 | 
			
		||||
	Ready() bool
 | 
			
		||||
	// Health returns broker health
 | 
			
		||||
	Health() bool
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Handler is used to process messages via a subscription of a topic.
 | 
			
		||||
type Handler func(Event) error
 | 
			
		||||
type (
 | 
			
		||||
	FuncPublish   func(ctx context.Context, topic string, messages ...Message) error
 | 
			
		||||
	HookPublish   func(next FuncPublish) FuncPublish
 | 
			
		||||
	FuncSubscribe func(ctx context.Context, topic string, handler interface{}, opts ...SubscribeOption) (Subscriber, error)
 | 
			
		||||
	HookSubscribe func(next FuncSubscribe) FuncSubscribe
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Event is given to a subscription handler for processing
 | 
			
		||||
type Event interface {
 | 
			
		||||
// Message is given to a subscription handler for processing
 | 
			
		||||
type Message interface {
 | 
			
		||||
	// Context for the message.
 | 
			
		||||
	Context() context.Context
 | 
			
		||||
	// Topic returns message destination topic.
 | 
			
		||||
	Topic() string
 | 
			
		||||
	Message() *Message
 | 
			
		||||
	// Header returns message headers.
 | 
			
		||||
	Header() metadata.Metadata
 | 
			
		||||
	// Body returns broker message []byte slice
 | 
			
		||||
	Body() []byte
 | 
			
		||||
	// Unmarshal try to decode message body to dst.
 | 
			
		||||
	// This is helper method that uses codec.Unmarshal.
 | 
			
		||||
	Unmarshal(dst interface{}, opts ...codec.Option) error
 | 
			
		||||
	// Ack acknowledge message if supported.
 | 
			
		||||
	Ack() error
 | 
			
		||||
	Error() error
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Message is used to transfer data
 | 
			
		||||
type Message struct {
 | 
			
		||||
	Header metadata.Metadata // contains message metadata
 | 
			
		||||
	Body   []byte            // contains message body
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Subscriber is a convenience return type for the Subscribe method
 | 
			
		||||
type Subscriber interface {
 | 
			
		||||
	// Options returns subscriber options
 | 
			
		||||
	Options() SubscribeOptions
 | 
			
		||||
	// Topic returns topic for subscription
 | 
			
		||||
	Topic() string
 | 
			
		||||
	Unsubscribe(context.Context) error
 | 
			
		||||
	// Unsubscribe from topic
 | 
			
		||||
	Unsubscribe(ctx context.Context) error
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -15,6 +15,15 @@ func FromContext(ctx context.Context) (Broker, bool) {
 | 
			
		||||
	return c, ok
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// MustContext returns broker from passed context
 | 
			
		||||
func MustContext(ctx context.Context) Broker {
 | 
			
		||||
	b, ok := FromContext(ctx)
 | 
			
		||||
	if !ok {
 | 
			
		||||
		panic("missing broker")
 | 
			
		||||
	}
 | 
			
		||||
	return b
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewContext savess broker in context
 | 
			
		||||
func NewContext(ctx context.Context, s Broker) context.Context {
 | 
			
		||||
	if ctx == nil {
 | 
			
		||||
@@ -33,16 +42,6 @@ func SetSubscribeOption(k, v interface{}) SubscribeOption {
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SetOption returns a function to setup a context with given value
 | 
			
		||||
func SetOption(k, v interface{}) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		if o.Context == nil {
 | 
			
		||||
			o.Context = context.Background()
 | 
			
		||||
		}
 | 
			
		||||
		o.Context = context.WithValue(o.Context, k, v)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SetPublishOption returns a function to setup a context with given value
 | 
			
		||||
func SetPublishOption(k, v interface{}) PublishOption {
 | 
			
		||||
	return func(o *PublishOptions) {
 | 
			
		||||
@@ -52,3 +51,13 @@ func SetPublishOption(k, v interface{}) PublishOption {
 | 
			
		||||
		o.Context = context.WithValue(o.Context, k, v)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SetOption returns a function to setup a context with given value
 | 
			
		||||
func SetOption(k, v interface{}) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		if o.Context == nil {
 | 
			
		||||
			o.Context = context.Background()
 | 
			
		||||
		}
 | 
			
		||||
		o.Context = context.WithValue(o.Context, k, v)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										61
									
								
								broker/context_test.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										61
									
								
								broker/context_test.go
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,61 @@
 | 
			
		||||
package broker
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"testing"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
func TestFromContext(t *testing.T) {
 | 
			
		||||
	ctx := context.WithValue(context.TODO(), brokerKey{}, NewBroker())
 | 
			
		||||
	c, ok := FromContext(ctx)
 | 
			
		||||
	if c == nil || !ok {
 | 
			
		||||
		t.Fatal("FromContext not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestFromNilContext(t *testing.T) {
 | 
			
		||||
	// nolint: staticcheck
 | 
			
		||||
	c, ok := FromContext(nil)
 | 
			
		||||
	if ok || c != nil {
 | 
			
		||||
		t.Fatal("FromContext not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestNewContext(t *testing.T) {
 | 
			
		||||
	ctx := NewContext(context.TODO(), NewBroker())
 | 
			
		||||
	c, ok := FromContext(ctx)
 | 
			
		||||
	if c == nil || !ok {
 | 
			
		||||
		t.Fatal("NewContext not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestNewNilContext(t *testing.T) {
 | 
			
		||||
	// nolint: staticcheck
 | 
			
		||||
	ctx := NewContext(nil, NewBroker())
 | 
			
		||||
	c, ok := FromContext(ctx)
 | 
			
		||||
	if c == nil || !ok {
 | 
			
		||||
		t.Fatal("NewContext not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestSetSubscribeOption(t *testing.T) {
 | 
			
		||||
	type key struct{}
 | 
			
		||||
	o := SetSubscribeOption(key{}, "test")
 | 
			
		||||
	opts := &SubscribeOptions{}
 | 
			
		||||
	o(opts)
 | 
			
		||||
 | 
			
		||||
	if v, ok := opts.Context.Value(key{}).(string); !ok || v == "" {
 | 
			
		||||
		t.Fatal("SetSubscribeOption not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestSetOption(t *testing.T) {
 | 
			
		||||
	type key struct{}
 | 
			
		||||
	o := SetOption(key{}, "test")
 | 
			
		||||
	opts := &Options{}
 | 
			
		||||
	o(opts)
 | 
			
		||||
 | 
			
		||||
	if v, ok := opts.Context.Value(key{}).(string); !ok || v == "" {
 | 
			
		||||
		t.Fatal("SetOption not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										244
									
								
								broker/memory.go
									
									
									
									
									
								
							
							
						
						
									
										244
									
								
								broker/memory.go
									
									
									
									
									
								
							@@ -1,244 +0,0 @@
 | 
			
		||||
package broker
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"errors"
 | 
			
		||||
	"sync"
 | 
			
		||||
 | 
			
		||||
	"github.com/google/uuid"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/logger"
 | 
			
		||||
	maddr "github.com/unistack-org/micro/v3/util/addr"
 | 
			
		||||
	mnet "github.com/unistack-org/micro/v3/util/net"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/util/rand"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
type memoryBroker struct {
 | 
			
		||||
	opts Options
 | 
			
		||||
 | 
			
		||||
	addr string
 | 
			
		||||
	sync.RWMutex
 | 
			
		||||
	connected   bool
 | 
			
		||||
	Subscribers map[string][]*memorySubscriber
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
type memoryEvent struct {
 | 
			
		||||
	opts    Options
 | 
			
		||||
	topic   string
 | 
			
		||||
	err     error
 | 
			
		||||
	message interface{}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
type memorySubscriber struct {
 | 
			
		||||
	id      string
 | 
			
		||||
	topic   string
 | 
			
		||||
	exit    chan bool
 | 
			
		||||
	handler Handler
 | 
			
		||||
	opts    SubscribeOptions
 | 
			
		||||
	ctx     context.Context
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *memoryBroker) Options() Options {
 | 
			
		||||
	return m.opts
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *memoryBroker) Address() string {
 | 
			
		||||
	return m.addr
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *memoryBroker) Connect(ctx context.Context) error {
 | 
			
		||||
	m.Lock()
 | 
			
		||||
	defer m.Unlock()
 | 
			
		||||
 | 
			
		||||
	if m.connected {
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// use 127.0.0.1 to avoid scan of all network interfaces
 | 
			
		||||
	addr, err := maddr.Extract("127.0.0.1")
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		return err
 | 
			
		||||
	}
 | 
			
		||||
	var rng rand.Rand
 | 
			
		||||
	i := rng.Intn(20000)
 | 
			
		||||
	// set addr with port
 | 
			
		||||
	addr = mnet.HostPort(addr, 10000+i)
 | 
			
		||||
 | 
			
		||||
	m.addr = addr
 | 
			
		||||
	m.connected = true
 | 
			
		||||
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *memoryBroker) Disconnect(ctx context.Context) error {
 | 
			
		||||
	m.Lock()
 | 
			
		||||
	defer m.Unlock()
 | 
			
		||||
 | 
			
		||||
	if !m.connected {
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	m.connected = false
 | 
			
		||||
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *memoryBroker) Init(opts ...Option) error {
 | 
			
		||||
	for _, o := range opts {
 | 
			
		||||
		o(&m.opts)
 | 
			
		||||
	}
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *memoryBroker) Publish(ctx context.Context, topic string, msg *Message, opts ...PublishOption) error {
 | 
			
		||||
	m.RLock()
 | 
			
		||||
	if !m.connected {
 | 
			
		||||
		m.RUnlock()
 | 
			
		||||
		return errors.New("not connected")
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	subs, ok := m.Subscribers[topic]
 | 
			
		||||
	m.RUnlock()
 | 
			
		||||
	if !ok {
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	var v interface{}
 | 
			
		||||
	if m.opts.Codec != nil {
 | 
			
		||||
		buf, err := m.opts.Codec.Marshal(msg)
 | 
			
		||||
		if err != nil {
 | 
			
		||||
			return err
 | 
			
		||||
		}
 | 
			
		||||
		v = buf
 | 
			
		||||
	} else {
 | 
			
		||||
		v = msg
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	p := &memoryEvent{
 | 
			
		||||
		topic:   topic,
 | 
			
		||||
		message: v,
 | 
			
		||||
		opts:    m.opts,
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	eh := m.opts.ErrorHandler
 | 
			
		||||
 | 
			
		||||
	for _, sub := range subs {
 | 
			
		||||
		if err := sub.handler(p); err != nil {
 | 
			
		||||
			p.err = err
 | 
			
		||||
			if sub.opts.ErrorHandler != nil {
 | 
			
		||||
				eh = sub.opts.ErrorHandler
 | 
			
		||||
			}
 | 
			
		||||
			if eh != nil {
 | 
			
		||||
				eh(p)
 | 
			
		||||
			} else if m.opts.Logger.V(logger.ErrorLevel) {
 | 
			
		||||
				m.opts.Logger.Error(m.opts.Context, err.Error())
 | 
			
		||||
			}
 | 
			
		||||
			continue
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *memoryBroker) Subscribe(ctx context.Context, topic string, handler Handler, opts ...SubscribeOption) (Subscriber, error) {
 | 
			
		||||
	m.RLock()
 | 
			
		||||
	if !m.connected {
 | 
			
		||||
		m.RUnlock()
 | 
			
		||||
		return nil, errors.New("not connected")
 | 
			
		||||
	}
 | 
			
		||||
	m.RUnlock()
 | 
			
		||||
 | 
			
		||||
	options := NewSubscribeOptions(opts...)
 | 
			
		||||
 | 
			
		||||
	id, err := uuid.NewRandom()
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		return nil, err
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	sub := &memorySubscriber{
 | 
			
		||||
		exit:    make(chan bool, 1),
 | 
			
		||||
		id:      id.String(),
 | 
			
		||||
		topic:   topic,
 | 
			
		||||
		handler: handler,
 | 
			
		||||
		opts:    options,
 | 
			
		||||
		ctx:     ctx,
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	m.Lock()
 | 
			
		||||
	m.Subscribers[topic] = append(m.Subscribers[topic], sub)
 | 
			
		||||
	m.Unlock()
 | 
			
		||||
 | 
			
		||||
	go func() {
 | 
			
		||||
		<-sub.exit
 | 
			
		||||
		m.Lock()
 | 
			
		||||
		var newSubscribers []*memorySubscriber
 | 
			
		||||
		for _, sb := range m.Subscribers[topic] {
 | 
			
		||||
			if sb.id == sub.id {
 | 
			
		||||
				continue
 | 
			
		||||
			}
 | 
			
		||||
			newSubscribers = append(newSubscribers, sb)
 | 
			
		||||
		}
 | 
			
		||||
		m.Subscribers[topic] = newSubscribers
 | 
			
		||||
		m.Unlock()
 | 
			
		||||
	}()
 | 
			
		||||
 | 
			
		||||
	return sub, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *memoryBroker) String() string {
 | 
			
		||||
	return "memory"
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *memoryBroker) Name() string {
 | 
			
		||||
	return m.opts.Name
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *memoryEvent) Topic() string {
 | 
			
		||||
	return m.topic
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *memoryEvent) Message() *Message {
 | 
			
		||||
	switch v := m.message.(type) {
 | 
			
		||||
	case *Message:
 | 
			
		||||
		return v
 | 
			
		||||
	case []byte:
 | 
			
		||||
		msg := &Message{}
 | 
			
		||||
		if err := m.opts.Codec.Unmarshal(v, msg); err != nil {
 | 
			
		||||
			if m.opts.Logger.V(logger.ErrorLevel) {
 | 
			
		||||
				m.opts.Logger.Error(m.opts.Context, "[memory]: failed to unmarshal: %v", err)
 | 
			
		||||
			}
 | 
			
		||||
			return nil
 | 
			
		||||
		}
 | 
			
		||||
		return msg
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *memoryEvent) Ack() error {
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *memoryEvent) Error() error {
 | 
			
		||||
	return m.err
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *memorySubscriber) Options() SubscribeOptions {
 | 
			
		||||
	return m.opts
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *memorySubscriber) Topic() string {
 | 
			
		||||
	return m.topic
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *memorySubscriber) Unsubscribe(ctx context.Context) error {
 | 
			
		||||
	m.exit <- true
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewBroker return new memory broker
 | 
			
		||||
func NewBroker(opts ...Option) Broker {
 | 
			
		||||
	return &memoryBroker{
 | 
			
		||||
		opts:        NewOptions(opts...),
 | 
			
		||||
		Subscribers: make(map[string][]*memorySubscriber),
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										338
									
								
								broker/memory/memory.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										338
									
								
								broker/memory/memory.go
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,338 @@
 | 
			
		||||
package broker
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"strings"
 | 
			
		||||
	"sync"
 | 
			
		||||
 | 
			
		||||
	"go.unistack.org/micro/v4/broker"
 | 
			
		||||
	"go.unistack.org/micro/v4/codec"
 | 
			
		||||
	"go.unistack.org/micro/v4/logger"
 | 
			
		||||
	"go.unistack.org/micro/v4/metadata"
 | 
			
		||||
	"go.unistack.org/micro/v4/options"
 | 
			
		||||
	maddr "go.unistack.org/micro/v4/util/addr"
 | 
			
		||||
	"go.unistack.org/micro/v4/util/id"
 | 
			
		||||
	mnet "go.unistack.org/micro/v4/util/net"
 | 
			
		||||
	"go.unistack.org/micro/v4/util/rand"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
type Broker struct {
 | 
			
		||||
	funcPublish   broker.FuncPublish
 | 
			
		||||
	funcSubscribe broker.FuncSubscribe
 | 
			
		||||
	subscribers   map[string][]*Subscriber
 | 
			
		||||
	addr          string
 | 
			
		||||
	opts          broker.Options
 | 
			
		||||
	sync.RWMutex
 | 
			
		||||
	connected bool
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
type memoryMessage struct {
 | 
			
		||||
	c     codec.Codec
 | 
			
		||||
	topic string
 | 
			
		||||
	ctx   context.Context
 | 
			
		||||
	body  []byte
 | 
			
		||||
	hdr   metadata.Metadata
 | 
			
		||||
	opts  broker.PublishOptions
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *memoryMessage) Ack() error {
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *memoryMessage) Body() []byte {
 | 
			
		||||
	return m.body
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *memoryMessage) Header() metadata.Metadata {
 | 
			
		||||
	return m.hdr
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *memoryMessage) Context() context.Context {
 | 
			
		||||
	return m.ctx
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *memoryMessage) Topic() string {
 | 
			
		||||
	return ""
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *memoryMessage) Unmarshal(dst interface{}, opts ...codec.Option) error {
 | 
			
		||||
	return m.c.Unmarshal(m.body, dst)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
type Subscriber struct {
 | 
			
		||||
	ctx     context.Context
 | 
			
		||||
	exit    chan bool
 | 
			
		||||
	handler interface{}
 | 
			
		||||
	id      string
 | 
			
		||||
	topic   string
 | 
			
		||||
	opts    broker.SubscribeOptions
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *Broker) newCodec(ct string) (codec.Codec, error) {
 | 
			
		||||
	if idx := strings.IndexRune(ct, ';'); idx >= 0 {
 | 
			
		||||
		ct = ct[:idx]
 | 
			
		||||
	}
 | 
			
		||||
	b.RLock()
 | 
			
		||||
	c, ok := b.opts.Codecs[ct]
 | 
			
		||||
	b.RUnlock()
 | 
			
		||||
	if ok {
 | 
			
		||||
		return c, nil
 | 
			
		||||
	}
 | 
			
		||||
	return nil, codec.ErrUnknownContentType
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *Broker) Options() broker.Options {
 | 
			
		||||
	return b.opts
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *Broker) Address() string {
 | 
			
		||||
	return b.addr
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *Broker) Connect(ctx context.Context) error {
 | 
			
		||||
	select {
 | 
			
		||||
	case <-ctx.Done():
 | 
			
		||||
		return ctx.Err()
 | 
			
		||||
	default:
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	b.Lock()
 | 
			
		||||
	defer b.Unlock()
 | 
			
		||||
 | 
			
		||||
	if b.connected {
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// use 127.0.0.1 to avoid scan of all network interfaces
 | 
			
		||||
	addr, err := maddr.Extract("127.0.0.1")
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		return err
 | 
			
		||||
	}
 | 
			
		||||
	var rng rand.Rand
 | 
			
		||||
	i := rng.Intn(20000)
 | 
			
		||||
	// set addr with port
 | 
			
		||||
	addr = mnet.HostPort(addr, 10000+i)
 | 
			
		||||
 | 
			
		||||
	b.addr = addr
 | 
			
		||||
	b.connected = true
 | 
			
		||||
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *Broker) Disconnect(ctx context.Context) error {
 | 
			
		||||
	select {
 | 
			
		||||
	case <-ctx.Done():
 | 
			
		||||
		return ctx.Err()
 | 
			
		||||
	default:
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	b.Lock()
 | 
			
		||||
	defer b.Unlock()
 | 
			
		||||
 | 
			
		||||
	if !b.connected {
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	b.connected = false
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *Broker) Init(opts ...broker.Option) error {
 | 
			
		||||
	for _, o := range opts {
 | 
			
		||||
		o(&b.opts)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	b.funcPublish = b.fnPublish
 | 
			
		||||
	b.funcSubscribe = b.fnSubscribe
 | 
			
		||||
 | 
			
		||||
	b.opts.Hooks.EachPrev(func(hook options.Hook) {
 | 
			
		||||
		switch h := hook.(type) {
 | 
			
		||||
		case broker.HookPublish:
 | 
			
		||||
			b.funcPublish = h(b.funcPublish)
 | 
			
		||||
		case broker.HookSubscribe:
 | 
			
		||||
			b.funcSubscribe = h(b.funcSubscribe)
 | 
			
		||||
		}
 | 
			
		||||
	})
 | 
			
		||||
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *Broker) NewMessage(ctx context.Context, hdr metadata.Metadata, body interface{}, opts ...broker.PublishOption) (broker.Message, error) {
 | 
			
		||||
	options := broker.NewPublishOptions(opts...)
 | 
			
		||||
	m := &memoryMessage{ctx: ctx, hdr: hdr, opts: options}
 | 
			
		||||
	c, err := b.newCodec(m.opts.ContentType)
 | 
			
		||||
	if err == nil {
 | 
			
		||||
		m.body, err = c.Marshal(body)
 | 
			
		||||
	}
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		return nil, err
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return m, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *Broker) Publish(ctx context.Context, topic string, messages ...broker.Message) error {
 | 
			
		||||
	return b.funcPublish(ctx, topic, messages...)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *Broker) fnPublish(ctx context.Context, topic string, messages ...broker.Message) error {
 | 
			
		||||
	return b.publish(ctx, topic, messages...)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *Broker) publish(ctx context.Context, topic string, messages ...broker.Message) error {
 | 
			
		||||
	b.RLock()
 | 
			
		||||
	if !b.connected {
 | 
			
		||||
		b.RUnlock()
 | 
			
		||||
		return broker.ErrNotConnected
 | 
			
		||||
	}
 | 
			
		||||
	b.RUnlock()
 | 
			
		||||
 | 
			
		||||
	select {
 | 
			
		||||
	case <-ctx.Done():
 | 
			
		||||
		return ctx.Err()
 | 
			
		||||
	default:
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	b.RLock()
 | 
			
		||||
	subs, ok := b.subscribers[topic]
 | 
			
		||||
	b.RUnlock()
 | 
			
		||||
	if !ok {
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	var err error
 | 
			
		||||
 | 
			
		||||
	for _, sub := range subs {
 | 
			
		||||
		switch s := sub.handler.(type) {
 | 
			
		||||
		default:
 | 
			
		||||
			if b.opts.Logger.V(logger.ErrorLevel) {
 | 
			
		||||
				b.opts.Logger.Error(ctx, "broker  handler error", broker.ErrInvalidHandler)
 | 
			
		||||
			}
 | 
			
		||||
		case func(broker.Message) error:
 | 
			
		||||
			for _, message := range messages {
 | 
			
		||||
				msg, ok := message.(*memoryMessage)
 | 
			
		||||
				if !ok {
 | 
			
		||||
					if b.opts.Logger.V(logger.ErrorLevel) {
 | 
			
		||||
						b.opts.Logger.Error(ctx, "broker handler error", broker.ErrInvalidMessage)
 | 
			
		||||
					}
 | 
			
		||||
				}
 | 
			
		||||
				msg.topic = topic
 | 
			
		||||
				if err = s(msg); err == nil && sub.opts.AutoAck {
 | 
			
		||||
					err = msg.Ack()
 | 
			
		||||
				}
 | 
			
		||||
				if err != nil {
 | 
			
		||||
					if b.opts.Logger.V(logger.ErrorLevel) {
 | 
			
		||||
						b.opts.Logger.Error(ctx, "broker handler error", err)
 | 
			
		||||
					}
 | 
			
		||||
				}
 | 
			
		||||
			}
 | 
			
		||||
		case func([]broker.Message) error:
 | 
			
		||||
			if err = s(messages); err == nil && sub.opts.AutoAck {
 | 
			
		||||
				for _, message := range messages {
 | 
			
		||||
					err = message.Ack()
 | 
			
		||||
					if err != nil {
 | 
			
		||||
						if b.opts.Logger.V(logger.ErrorLevel) {
 | 
			
		||||
							b.opts.Logger.Error(ctx, "broker handler error", err)
 | 
			
		||||
						}
 | 
			
		||||
					}
 | 
			
		||||
				}
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *Broker) Subscribe(ctx context.Context, topic string, handler interface{}, opts ...broker.SubscribeOption) (broker.Subscriber, error) {
 | 
			
		||||
	return b.funcSubscribe(ctx, topic, handler, opts...)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *Broker) fnSubscribe(ctx context.Context, topic string, handler interface{}, opts ...broker.SubscribeOption) (broker.Subscriber, error) {
 | 
			
		||||
	if err := broker.IsValidHandler(handler); err != nil {
 | 
			
		||||
		return nil, err
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	b.RLock()
 | 
			
		||||
	if !b.connected {
 | 
			
		||||
		b.RUnlock()
 | 
			
		||||
		return nil, broker.ErrNotConnected
 | 
			
		||||
	}
 | 
			
		||||
	b.RUnlock()
 | 
			
		||||
 | 
			
		||||
	sid, err := id.New()
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		return nil, err
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	options := broker.NewSubscribeOptions(opts...)
 | 
			
		||||
 | 
			
		||||
	sub := &Subscriber{
 | 
			
		||||
		exit:    make(chan bool, 1),
 | 
			
		||||
		id:      sid,
 | 
			
		||||
		topic:   topic,
 | 
			
		||||
		handler: handler,
 | 
			
		||||
		opts:    options,
 | 
			
		||||
		ctx:     ctx,
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	b.Lock()
 | 
			
		||||
	b.subscribers[topic] = append(b.subscribers[topic], sub)
 | 
			
		||||
	b.Unlock()
 | 
			
		||||
 | 
			
		||||
	go func() {
 | 
			
		||||
		<-sub.exit
 | 
			
		||||
		b.Lock()
 | 
			
		||||
		newSubscribers := make([]*Subscriber, 0, len(b.subscribers)-1)
 | 
			
		||||
		for _, sb := range b.subscribers[topic] {
 | 
			
		||||
			if sb.id == sub.id {
 | 
			
		||||
				continue
 | 
			
		||||
			}
 | 
			
		||||
			newSubscribers = append(newSubscribers, sb)
 | 
			
		||||
		}
 | 
			
		||||
		b.subscribers[topic] = newSubscribers
 | 
			
		||||
		b.Unlock()
 | 
			
		||||
	}()
 | 
			
		||||
 | 
			
		||||
	return sub, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *Broker) String() string {
 | 
			
		||||
	return "memory"
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *Broker) Name() string {
 | 
			
		||||
	return b.opts.Name
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *Broker) Live() bool {
 | 
			
		||||
	return true
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *Broker) Ready() bool {
 | 
			
		||||
	return true
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *Broker) Health() bool {
 | 
			
		||||
	return true
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *Subscriber) Options() broker.SubscribeOptions {
 | 
			
		||||
	return m.opts
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *Subscriber) Topic() string {
 | 
			
		||||
	return m.topic
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *Subscriber) Unsubscribe(ctx context.Context) error {
 | 
			
		||||
	m.exit <- true
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewBroker return new memory broker
 | 
			
		||||
func NewBroker(opts ...broker.Option) broker.Broker {
 | 
			
		||||
	return &Broker{
 | 
			
		||||
		opts:        broker.NewOptions(opts...),
 | 
			
		||||
		subscribers: make(map[string][]*Subscriber),
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										74
									
								
								broker/memory/memory_test.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										74
									
								
								broker/memory/memory_test.go
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,74 @@
 | 
			
		||||
package broker
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"fmt"
 | 
			
		||||
	"testing"
 | 
			
		||||
 | 
			
		||||
	"go.uber.org/atomic"
 | 
			
		||||
	"go.unistack.org/micro/v4/broker"
 | 
			
		||||
	"go.unistack.org/micro/v4/codec"
 | 
			
		||||
	"go.unistack.org/micro/v4/metadata"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
type hldr struct {
 | 
			
		||||
	c atomic.Int64
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (h *hldr) Handler(m broker.Message) error {
 | 
			
		||||
	h.c.Add(1)
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestMemoryBroker(t *testing.T) {
 | 
			
		||||
	b := NewBroker(broker.Codec("application/octet-stream", codec.NewCodec()))
 | 
			
		||||
	ctx := context.Background()
 | 
			
		||||
 | 
			
		||||
	if err := b.Init(); err != nil {
 | 
			
		||||
		t.Fatalf("Unexpected init error %v", err)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if err := b.Connect(ctx); err != nil {
 | 
			
		||||
		t.Fatalf("Unexpected connect error %v", err)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	topic := "test"
 | 
			
		||||
	count := int64(10)
 | 
			
		||||
 | 
			
		||||
	h := &hldr{}
 | 
			
		||||
 | 
			
		||||
	sub, err := b.Subscribe(ctx, topic, h.Handler)
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		t.Fatalf("Unexpected error subscribing %v", err)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	for i := int64(0); i < count; i++ {
 | 
			
		||||
		message, err := b.NewMessage(ctx,
 | 
			
		||||
			metadata.Pairs(
 | 
			
		||||
				"foo", "bar",
 | 
			
		||||
				"id", fmt.Sprintf("%d", i),
 | 
			
		||||
			),
 | 
			
		||||
			[]byte(`"hello world"`),
 | 
			
		||||
			broker.PublishContentType("application/octet-stream"),
 | 
			
		||||
		)
 | 
			
		||||
		if err != nil {
 | 
			
		||||
			t.Fatal(err)
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		if err := b.Publish(ctx, topic, message); err != nil {
 | 
			
		||||
			t.Fatalf("Unexpected error publishing %d err: %v", i, err)
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if err := sub.Unsubscribe(ctx); err != nil {
 | 
			
		||||
		t.Fatalf("Unexpected error unsubscribing from %s: %v", topic, err)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if err := b.Disconnect(ctx); err != nil {
 | 
			
		||||
		t.Fatalf("Unexpected connect error %v", err)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if h.c.Load() != count {
 | 
			
		||||
		t.Fatal("invalid messages count received")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
@@ -1,50 +0,0 @@
 | 
			
		||||
package broker
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"fmt"
 | 
			
		||||
	"testing"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
func TestMemoryBroker(t *testing.T) {
 | 
			
		||||
	b := NewBroker()
 | 
			
		||||
	ctx := context.Background()
 | 
			
		||||
 | 
			
		||||
	if err := b.Connect(ctx); err != nil {
 | 
			
		||||
		t.Fatalf("Unexpected connect error %v", err)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	topic := "test"
 | 
			
		||||
	count := 10
 | 
			
		||||
 | 
			
		||||
	fn := func(p Event) error {
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	sub, err := b.Subscribe(ctx, topic, fn)
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		t.Fatalf("Unexpected error subscribing %v", err)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	for i := 0; i < count; i++ {
 | 
			
		||||
		message := &Message{
 | 
			
		||||
			Header: map[string]string{
 | 
			
		||||
				"foo": "bar",
 | 
			
		||||
				"id":  fmt.Sprintf("%d", i),
 | 
			
		||||
			},
 | 
			
		||||
			Body: []byte(`hello world`),
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		if err := b.Publish(ctx, topic, message); err != nil {
 | 
			
		||||
			t.Fatalf("Unexpected error publishing %d", i)
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if err := sub.Unsubscribe(ctx); err != nil {
 | 
			
		||||
		t.Fatalf("Unexpected error unsubscribing from %s: %v", topic, err)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if err := b.Disconnect(ctx); err != nil {
 | 
			
		||||
		t.Fatalf("Unexpected connect error %v", err)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										176
									
								
								broker/noop.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										176
									
								
								broker/noop.go
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,176 @@
 | 
			
		||||
package broker
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"strings"
 | 
			
		||||
	"sync"
 | 
			
		||||
 | 
			
		||||
	"go.unistack.org/micro/v4/codec"
 | 
			
		||||
	"go.unistack.org/micro/v4/metadata"
 | 
			
		||||
	"go.unistack.org/micro/v4/options"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
type NoopBroker struct {
 | 
			
		||||
	funcPublish   FuncPublish
 | 
			
		||||
	funcSubscribe FuncSubscribe
 | 
			
		||||
	opts          Options
 | 
			
		||||
	sync.RWMutex
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *NoopBroker) newCodec(ct string) (codec.Codec, error) {
 | 
			
		||||
	if idx := strings.IndexRune(ct, ';'); idx >= 0 {
 | 
			
		||||
		ct = ct[:idx]
 | 
			
		||||
	}
 | 
			
		||||
	b.RLock()
 | 
			
		||||
	c, ok := b.opts.Codecs[ct]
 | 
			
		||||
	b.RUnlock()
 | 
			
		||||
	if ok {
 | 
			
		||||
		return c, nil
 | 
			
		||||
	}
 | 
			
		||||
	return nil, codec.ErrUnknownContentType
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func NewBroker(opts ...Option) *NoopBroker {
 | 
			
		||||
	b := &NoopBroker{opts: NewOptions(opts...)}
 | 
			
		||||
	b.funcPublish = b.fnPublish
 | 
			
		||||
	b.funcSubscribe = b.fnSubscribe
 | 
			
		||||
 | 
			
		||||
	return b
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *NoopBroker) Health() bool {
 | 
			
		||||
	return true
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *NoopBroker) Live() bool {
 | 
			
		||||
	return true
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *NoopBroker) Ready() bool {
 | 
			
		||||
	return true
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *NoopBroker) Name() string {
 | 
			
		||||
	return b.opts.Name
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *NoopBroker) String() string {
 | 
			
		||||
	return "noop"
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *NoopBroker) Options() Options {
 | 
			
		||||
	return b.opts
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *NoopBroker) Init(opts ...Option) error {
 | 
			
		||||
	for _, opt := range opts {
 | 
			
		||||
		opt(&b.opts)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	b.funcPublish = b.fnPublish
 | 
			
		||||
	b.funcSubscribe = b.fnSubscribe
 | 
			
		||||
 | 
			
		||||
	b.opts.Hooks.EachPrev(func(hook options.Hook) {
 | 
			
		||||
		switch h := hook.(type) {
 | 
			
		||||
		case HookPublish:
 | 
			
		||||
			b.funcPublish = h(b.funcPublish)
 | 
			
		||||
		case HookSubscribe:
 | 
			
		||||
			b.funcSubscribe = h(b.funcSubscribe)
 | 
			
		||||
		}
 | 
			
		||||
	})
 | 
			
		||||
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *NoopBroker) Connect(_ context.Context) error {
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *NoopBroker) Disconnect(_ context.Context) error {
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *NoopBroker) Address() string {
 | 
			
		||||
	return strings.Join(b.opts.Addrs, ",")
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
type noopMessage struct {
 | 
			
		||||
	c    codec.Codec
 | 
			
		||||
	ctx  context.Context
 | 
			
		||||
	body []byte
 | 
			
		||||
	hdr  metadata.Metadata
 | 
			
		||||
	opts PublishOptions
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *noopMessage) Ack() error {
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *noopMessage) Body() []byte {
 | 
			
		||||
	return m.body
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *noopMessage) Header() metadata.Metadata {
 | 
			
		||||
	return m.hdr
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *noopMessage) Context() context.Context {
 | 
			
		||||
	return m.ctx
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *noopMessage) Topic() string {
 | 
			
		||||
	return ""
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (m *noopMessage) Unmarshal(dst interface{}, opts ...codec.Option) error {
 | 
			
		||||
	return m.c.Unmarshal(m.body, dst)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *NoopBroker) NewMessage(ctx context.Context, hdr metadata.Metadata, body interface{}, opts ...PublishOption) (Message, error) {
 | 
			
		||||
	options := NewPublishOptions(opts...)
 | 
			
		||||
	m := &noopMessage{ctx: ctx, hdr: hdr, opts: options}
 | 
			
		||||
	c, err := b.newCodec(m.opts.ContentType)
 | 
			
		||||
	if err == nil {
 | 
			
		||||
		m.body, err = c.Marshal(body)
 | 
			
		||||
	}
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		return nil, err
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return m, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *NoopBroker) fnPublish(_ context.Context, _ string, _ ...Message) error {
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *NoopBroker) Publish(ctx context.Context, topic string, msg ...Message) error {
 | 
			
		||||
	return b.funcPublish(ctx, topic, msg...)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
type NoopSubscriber struct {
 | 
			
		||||
	ctx     context.Context
 | 
			
		||||
	topic   string
 | 
			
		||||
	handler interface{}
 | 
			
		||||
	opts    SubscribeOptions
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *NoopBroker) fnSubscribe(ctx context.Context, topic string, handler interface{}, opts ...SubscribeOption) (Subscriber, error) {
 | 
			
		||||
	return &NoopSubscriber{ctx: ctx, topic: topic, opts: NewSubscribeOptions(opts...), handler: handler}, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (b *NoopBroker) Subscribe(ctx context.Context, topic string, handler interface{}, opts ...SubscribeOption) (Subscriber, error) {
 | 
			
		||||
	return b.funcSubscribe(ctx, topic, handler, opts...)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *NoopSubscriber) Options() SubscribeOptions {
 | 
			
		||||
	return s.opts
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *NoopSubscriber) Topic() string {
 | 
			
		||||
	return s.topic
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *NoopSubscriber) Unsubscribe(_ context.Context) error {
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										35
									
								
								broker/noop_test.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										35
									
								
								broker/noop_test.go
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,35 @@
 | 
			
		||||
package broker
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"testing"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
type testHook struct {
 | 
			
		||||
	f bool
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (t *testHook) Publish1(fn FuncPublish) FuncPublish {
 | 
			
		||||
	return func(ctx context.Context, topic string, messages ...Message) error {
 | 
			
		||||
		t.f = true
 | 
			
		||||
		return fn(ctx, topic, messages...)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestNoopHook(t *testing.T) {
 | 
			
		||||
	h := &testHook{}
 | 
			
		||||
 | 
			
		||||
	b := NewBroker(Hooks(HookPublish(h.Publish1)))
 | 
			
		||||
 | 
			
		||||
	if err := b.Init(); err != nil {
 | 
			
		||||
		t.Fatal(err)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if err := b.Publish(context.TODO(), "", nil); err != nil {
 | 
			
		||||
		t.Fatal(err)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if !h.f {
 | 
			
		||||
		t.Fatal("hook not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
@@ -3,47 +3,62 @@ package broker
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"crypto/tls"
 | 
			
		||||
	"time"
 | 
			
		||||
 | 
			
		||||
	"github.com/unistack-org/micro/v3/codec"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/logger"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/meter"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/register"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/tracer"
 | 
			
		||||
	"go.unistack.org/micro/v4/codec"
 | 
			
		||||
	"go.unistack.org/micro/v4/logger"
 | 
			
		||||
	"go.unistack.org/micro/v4/meter"
 | 
			
		||||
	"go.unistack.org/micro/v4/options"
 | 
			
		||||
	"go.unistack.org/micro/v4/register"
 | 
			
		||||
	"go.unistack.org/micro/v4/sync"
 | 
			
		||||
	"go.unistack.org/micro/v4/tracer"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Options struct
 | 
			
		||||
type Options struct {
 | 
			
		||||
	// Name holds the broker name
 | 
			
		||||
	Name string
 | 
			
		||||
	// Addrs useed by broker
 | 
			
		||||
	Addrs []string
 | 
			
		||||
	// ErrorHandler executed when errors occur processing messages
 | 
			
		||||
	ErrorHandler Handler
 | 
			
		||||
	// Codec used to marshal/unmarshal messages
 | 
			
		||||
	Codec codec.Codec
 | 
			
		||||
	// Logger the used logger
 | 
			
		||||
	Logger logger.Logger
 | 
			
		||||
	// Meter the used for metrics
 | 
			
		||||
	Meter meter.Meter
 | 
			
		||||
	// Tracer used for trace
 | 
			
		||||
 | 
			
		||||
	// Tracer used for tracing
 | 
			
		||||
	Tracer tracer.Tracer
 | 
			
		||||
	// TLSConfig for secure communication
 | 
			
		||||
	TLSConfig *tls.Config
 | 
			
		||||
	// Register used for clustering
 | 
			
		||||
	// Register can be used for clustering
 | 
			
		||||
	Register register.Register
 | 
			
		||||
	// Context is used for non default options
 | 
			
		||||
	// Codecs holds the codecs for marshal/unmarshal based on content-type
 | 
			
		||||
	Codecs map[string]codec.Codec
 | 
			
		||||
	// Logger used for logging
 | 
			
		||||
	Logger logger.Logger
 | 
			
		||||
	// Meter used for metrics
 | 
			
		||||
	Meter meter.Meter
 | 
			
		||||
	// Context holds external options
 | 
			
		||||
	Context context.Context
 | 
			
		||||
 | 
			
		||||
	// Wait waits for a collection of goroutines to finish
 | 
			
		||||
	Wait *sync.WaitGroup
 | 
			
		||||
	// TLSConfig holds tls.TLSConfig options
 | 
			
		||||
	TLSConfig *tls.Config
 | 
			
		||||
 | 
			
		||||
	// Addrs holds the broker address
 | 
			
		||||
	Addrs []string
 | 
			
		||||
	// Hooks can be run before broker Publish/BatchPublish and
 | 
			
		||||
	// Subscribe/BatchSubscribe methods
 | 
			
		||||
	Hooks options.Hooks
 | 
			
		||||
 | 
			
		||||
	// GracefulTimeout contains time to wait to finish in flight requests
 | 
			
		||||
	GracefulTimeout time.Duration
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewOptions create new Options
 | 
			
		||||
func NewOptions(opts ...Option) Options {
 | 
			
		||||
	options := Options{
 | 
			
		||||
		Register: register.DefaultRegister,
 | 
			
		||||
		Logger:   logger.DefaultLogger,
 | 
			
		||||
		Context:  context.Background(),
 | 
			
		||||
		Meter:    meter.DefaultMeter,
 | 
			
		||||
		Codec:    codec.DefaultCodec,
 | 
			
		||||
		Tracer:   tracer.DefaultTracer,
 | 
			
		||||
		Register:        register.DefaultRegister,
 | 
			
		||||
		Logger:          logger.DefaultLogger,
 | 
			
		||||
		Context:         context.Background(),
 | 
			
		||||
		Meter:           meter.DefaultMeter,
 | 
			
		||||
		Codecs:          make(map[string]codec.Codec),
 | 
			
		||||
		Tracer:          tracer.DefaultTracer,
 | 
			
		||||
		GracefulTimeout: DefaultGracefulTimeout,
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	for _, o := range opts {
 | 
			
		||||
		o(&options)
 | 
			
		||||
	}
 | 
			
		||||
@@ -59,9 +74,12 @@ func Context(ctx context.Context) Option {
 | 
			
		||||
 | 
			
		||||
// PublishOptions struct
 | 
			
		||||
type PublishOptions struct {
 | 
			
		||||
	// BodyOnly says that only body of the message must be published
 | 
			
		||||
	// ContentType for message body
 | 
			
		||||
	ContentType string
 | 
			
		||||
	// BodyOnly flag says the message contains raw body bytes and don't need
 | 
			
		||||
	// codec Marshal method
 | 
			
		||||
	BodyOnly bool
 | 
			
		||||
	// Context for non default options
 | 
			
		||||
	// Context holds custom options
 | 
			
		||||
	Context context.Context
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
@@ -70,32 +88,26 @@ func NewPublishOptions(opts ...PublishOption) PublishOptions {
 | 
			
		||||
	options := PublishOptions{
 | 
			
		||||
		Context: context.Background(),
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	for _, o := range opts {
 | 
			
		||||
		o(&options)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return options
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SubscribeOptions struct
 | 
			
		||||
type SubscribeOptions struct {
 | 
			
		||||
	// AutoAck ack messages if handler returns nil err
 | 
			
		||||
	AutoAck bool
 | 
			
		||||
 | 
			
		||||
	// ErrorHandler executed when errors occur processing messages
 | 
			
		||||
	ErrorHandler Handler
 | 
			
		||||
 | 
			
		||||
	// Group for subscriber, Subscribers with the same group name
 | 
			
		||||
	// will create a shared subscription where each
 | 
			
		||||
	// receives a subset of messages.
 | 
			
		||||
	Group string
 | 
			
		||||
 | 
			
		||||
	// BodyOnly says that consumed only body of the message
 | 
			
		||||
	BodyOnly bool
 | 
			
		||||
 | 
			
		||||
	// Context is used for non default options
 | 
			
		||||
	// Context holds external options
 | 
			
		||||
	Context context.Context
 | 
			
		||||
	// Group holds consumer group
 | 
			
		||||
	Group string
 | 
			
		||||
	// AutoAck flag specifies auto ack of incoming message when no error happens
 | 
			
		||||
	AutoAck bool
 | 
			
		||||
	// BodyOnly flag specifies that message contains only body bytes without header
 | 
			
		||||
	BodyOnly bool
 | 
			
		||||
	// BatchSize flag specifies max batch size
 | 
			
		||||
	BatchSize int
 | 
			
		||||
	// BatchWait flag specifies max wait time for batch filling
 | 
			
		||||
	BatchWait time.Duration
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Option func
 | 
			
		||||
@@ -104,6 +116,13 @@ type Option func(*Options)
 | 
			
		||||
// PublishOption func
 | 
			
		||||
type PublishOption func(*PublishOptions)
 | 
			
		||||
 | 
			
		||||
// PublishContentType sets message content-type that used to Marshal
 | 
			
		||||
func PublishContentType(ct string) PublishOption {
 | 
			
		||||
	return func(o *PublishOptions) {
 | 
			
		||||
		o.ContentType = ct
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// PublishBodyOnly publish only body of the message
 | 
			
		||||
func PublishBodyOnly(b bool) PublishOption {
 | 
			
		||||
	return func(o *PublishOptions) {
 | 
			
		||||
@@ -111,30 +130,6 @@ func PublishBodyOnly(b bool) PublishOption {
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// PublishContext sets the context
 | 
			
		||||
func PublishContext(ctx context.Context) PublishOption {
 | 
			
		||||
	return func(o *PublishOptions) {
 | 
			
		||||
		o.Context = ctx
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SubscribeOption func
 | 
			
		||||
type SubscribeOption func(*SubscribeOptions)
 | 
			
		||||
 | 
			
		||||
// NewSubscribeOptions creates new SubscribeOptions
 | 
			
		||||
func NewSubscribeOptions(opts ...SubscribeOption) SubscribeOptions {
 | 
			
		||||
	options := SubscribeOptions{
 | 
			
		||||
		AutoAck: true,
 | 
			
		||||
		Context: context.Background(),
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	for _, o := range opts {
 | 
			
		||||
		o(&options)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return options
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Addrs sets the host addresses to be used by the broker
 | 
			
		||||
func Addrs(addrs ...string) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
@@ -142,57 +137,10 @@ func Addrs(addrs ...string) Option {
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Codec sets the codec used for encoding/decoding used where
 | 
			
		||||
// a broker does not support headers
 | 
			
		||||
func Codec(c codec.Codec) Option {
 | 
			
		||||
// Codec sets the codec used for encoding/decoding messages
 | 
			
		||||
func Codec(ct string, c codec.Codec) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.Codec = c
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// DisableAutoAck disables auto ack
 | 
			
		||||
func DisableAutoAck() SubscribeOption {
 | 
			
		||||
	return func(o *SubscribeOptions) {
 | 
			
		||||
		o.AutoAck = false
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SubscribeAutoAck will disable auto acking of messages
 | 
			
		||||
// after they have been handled.
 | 
			
		||||
func SubscribeAutoAck(b bool) SubscribeOption {
 | 
			
		||||
	return func(o *SubscribeOptions) {
 | 
			
		||||
		o.AutoAck = b
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SubscribeBodyOnly consumes only body of the message
 | 
			
		||||
func SubscribeBodyOnly(b bool) SubscribeOption {
 | 
			
		||||
	return func(o *SubscribeOptions) {
 | 
			
		||||
		o.BodyOnly = b
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// ErrorHandler will catch all broker errors that cant be handled
 | 
			
		||||
// in normal way, for example Codec errors
 | 
			
		||||
func ErrorHandler(h Handler) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.ErrorHandler = h
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SubscribeErrorHandler will catch all broker errors that cant be handled
 | 
			
		||||
// in normal way, for example Codec errors
 | 
			
		||||
func SubscribeErrorHandler(h Handler) SubscribeOption {
 | 
			
		||||
	return func(o *SubscribeOptions) {
 | 
			
		||||
		o.ErrorHandler = h
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Queue sets the subscribers queue
 | 
			
		||||
// Deprecated
 | 
			
		||||
func Queue(name string) SubscribeOption {
 | 
			
		||||
	return func(o *SubscribeOptions) {
 | 
			
		||||
		o.Group = name
 | 
			
		||||
		o.Codecs[ct] = c
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
@@ -245,9 +193,60 @@ func Name(n string) Option {
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Hooks sets hook runs before action
 | 
			
		||||
func Hooks(h ...options.Hook) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.Hooks = append(o.Hooks, h...)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SubscribeContext set context
 | 
			
		||||
func SubscribeContext(ctx context.Context) SubscribeOption {
 | 
			
		||||
	return func(o *SubscribeOptions) {
 | 
			
		||||
		o.Context = ctx
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SubscribeAutoAck contol auto acking of messages
 | 
			
		||||
// after they have been handled.
 | 
			
		||||
func SubscribeAutoAck(b bool) SubscribeOption {
 | 
			
		||||
	return func(o *SubscribeOptions) {
 | 
			
		||||
		o.AutoAck = b
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SubscribeBodyOnly consumes only body of the message
 | 
			
		||||
func SubscribeBodyOnly(b bool) SubscribeOption {
 | 
			
		||||
	return func(o *SubscribeOptions) {
 | 
			
		||||
		o.BodyOnly = b
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SubscribeBatchSize specifies max batch size
 | 
			
		||||
func SubscribeBatchSize(n int) SubscribeOption {
 | 
			
		||||
	return func(o *SubscribeOptions) {
 | 
			
		||||
		o.BatchSize = n
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SubscribeBatchWait specifies max batch wait time
 | 
			
		||||
func SubscribeBatchWait(td time.Duration) SubscribeOption {
 | 
			
		||||
	return func(o *SubscribeOptions) {
 | 
			
		||||
		o.BatchWait = td
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SubscribeOption func
 | 
			
		||||
type SubscribeOption func(*SubscribeOptions)
 | 
			
		||||
 | 
			
		||||
// NewSubscribeOptions creates new SubscribeOptions
 | 
			
		||||
func NewSubscribeOptions(opts ...SubscribeOption) SubscribeOptions {
 | 
			
		||||
	options := SubscribeOptions{
 | 
			
		||||
		AutoAck: true,
 | 
			
		||||
		Context: context.Background(),
 | 
			
		||||
	}
 | 
			
		||||
	for _, o := range opts {
 | 
			
		||||
		o(&options)
 | 
			
		||||
	}
 | 
			
		||||
	return options
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										14
									
								
								broker/subscriber.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										14
									
								
								broker/subscriber.go
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,14 @@
 | 
			
		||||
package broker
 | 
			
		||||
 | 
			
		||||
// IsValidHandler func signature
 | 
			
		||||
func IsValidHandler(sub interface{}) error {
 | 
			
		||||
	switch sub.(type) {
 | 
			
		||||
	default:
 | 
			
		||||
		return ErrInvalidHandler
 | 
			
		||||
	case func(Message) error:
 | 
			
		||||
		break
 | 
			
		||||
	case func([]Message) error:
 | 
			
		||||
		break
 | 
			
		||||
	}
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
@@ -1,32 +0,0 @@
 | 
			
		||||
// Package build is for building source into a package
 | 
			
		||||
package build
 | 
			
		||||
 | 
			
		||||
// Build is an interface for building packages
 | 
			
		||||
type Build interface {
 | 
			
		||||
	// Package builds a package
 | 
			
		||||
	Package(name string, src *Source) (*Package, error)
 | 
			
		||||
	// Remove removes the package
 | 
			
		||||
	Remove(*Package) error
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Source is the source of a build
 | 
			
		||||
type Source struct {
 | 
			
		||||
	// Path to the source if local
 | 
			
		||||
	Path string
 | 
			
		||||
	// Language is the language of code
 | 
			
		||||
	Language string
 | 
			
		||||
	// Location of the source
 | 
			
		||||
	Repository string
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Package is packaged format for source
 | 
			
		||||
type Package struct {
 | 
			
		||||
	// Name of the package
 | 
			
		||||
	Name string
 | 
			
		||||
	// Location of the package
 | 
			
		||||
	Path string
 | 
			
		||||
	// Type of package e.g tarball, binary, docker
 | 
			
		||||
	Type string
 | 
			
		||||
	// Source of the package
 | 
			
		||||
	Source *Source
 | 
			
		||||
}
 | 
			
		||||
@@ -1,17 +0,0 @@
 | 
			
		||||
package build
 | 
			
		||||
 | 
			
		||||
// Options struct
 | 
			
		||||
type Options struct {
 | 
			
		||||
	// local path to download source
 | 
			
		||||
	Path string
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Option func
 | 
			
		||||
type Option func(o *Options)
 | 
			
		||||
 | 
			
		||||
// Path is the Local path for repository
 | 
			
		||||
func Path(p string) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.Path = p
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
@@ -2,14 +2,29 @@ package client
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"math"
 | 
			
		||||
	"time"
 | 
			
		||||
 | 
			
		||||
	"github.com/unistack-org/micro/v3/util/backoff"
 | 
			
		||||
	"go.unistack.org/micro/v4/util/backoff"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// BackoffFunc is the backoff call func
 | 
			
		||||
type BackoffFunc func(ctx context.Context, req Request, attempts int) (time.Duration, error)
 | 
			
		||||
 | 
			
		||||
func exponentialBackoff(ctx context.Context, req Request, attempts int) (time.Duration, error) {
 | 
			
		||||
// BackoffExp using exponential backoff func
 | 
			
		||||
func BackoffExp(_ context.Context, _ Request, attempts int) (time.Duration, error) {
 | 
			
		||||
	return backoff.Do(attempts), nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// BackoffInterval specifies randomization interval for backoff func
 | 
			
		||||
func BackoffInterval(minTime time.Duration, maxTime time.Duration) BackoffFunc {
 | 
			
		||||
	return func(_ context.Context, _ Request, attempts int) (time.Duration, error) {
 | 
			
		||||
		td := time.Duration(math.Pow(float64(attempts), math.E)) * time.Millisecond * 100
 | 
			
		||||
		if td < minTime {
 | 
			
		||||
			return minTime, nil
 | 
			
		||||
		} else if td > maxTime {
 | 
			
		||||
			return maxTime, nil
 | 
			
		||||
		}
 | 
			
		||||
		return td, nil
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -6,7 +6,7 @@ import (
 | 
			
		||||
	"time"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
func TestBackoff(t *testing.T) {
 | 
			
		||||
func TestBackoffExp(t *testing.T) {
 | 
			
		||||
	results := []time.Duration{
 | 
			
		||||
		0 * time.Second,
 | 
			
		||||
		100 * time.Millisecond,
 | 
			
		||||
@@ -22,7 +22,7 @@ func TestBackoff(t *testing.T) {
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	for i := 0; i < 5; i++ {
 | 
			
		||||
		d, err := exponentialBackoff(context.TODO(), r, i)
 | 
			
		||||
		d, err := BackoffExp(context.TODO(), r, i)
 | 
			
		||||
		if err != nil {
 | 
			
		||||
			t.Fatal(err)
 | 
			
		||||
		}
 | 
			
		||||
@@ -32,3 +32,25 @@ func TestBackoff(t *testing.T) {
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestBackoffInterval(t *testing.T) {
 | 
			
		||||
	minTime := 100 * time.Millisecond
 | 
			
		||||
	maxTime := 300 * time.Millisecond
 | 
			
		||||
 | 
			
		||||
	r := &testRequest{
 | 
			
		||||
		service: "test",
 | 
			
		||||
		method:  "test",
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	fn := BackoffInterval(minTime, maxTime)
 | 
			
		||||
	for i := 0; i < 5; i++ {
 | 
			
		||||
		d, err := fn(context.TODO(), r, i)
 | 
			
		||||
		if err != nil {
 | 
			
		||||
			t.Fatal(err)
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		if d < minTime || d > maxTime {
 | 
			
		||||
			t.Fatalf("Expected %v < %v < %v", minTime, d, maxTime)
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -5,17 +5,17 @@ import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"time"
 | 
			
		||||
 | 
			
		||||
	"github.com/unistack-org/micro/v3/codec"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/metadata"
 | 
			
		||||
	"go.unistack.org/micro/v4/codec"
 | 
			
		||||
	"go.unistack.org/micro/v4/metadata"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
var (
 | 
			
		||||
	// DefaultClient is the global default client
 | 
			
		||||
	DefaultClient Client = NewClient()
 | 
			
		||||
	DefaultClient = NewClient()
 | 
			
		||||
	// DefaultContentType is the default content-type if not specified
 | 
			
		||||
	DefaultContentType = "application/json"
 | 
			
		||||
	// DefaultBackoff is the default backoff function for retries
 | 
			
		||||
	DefaultBackoff = exponentialBackoff
 | 
			
		||||
	DefaultContentType = ""
 | 
			
		||||
	// DefaultBackoff is the default backoff function for retries (minimum 10 millisecond and maximum 5 second)
 | 
			
		||||
	DefaultBackoff = BackoffInterval(10*time.Millisecond, 5*time.Second)
 | 
			
		||||
	// DefaultRetry is the default check-for-retry function for retries
 | 
			
		||||
	DefaultRetry = RetryNever
 | 
			
		||||
	// DefaultRetries is the default number of times a request is tried
 | 
			
		||||
@@ -29,26 +29,23 @@ var (
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Client is the interface used to make requests to services.
 | 
			
		||||
// It supports Request/Response via Transport and Publishing via the Broker.
 | 
			
		||||
// It also supports bidirectional streaming of requests.
 | 
			
		||||
type Client interface {
 | 
			
		||||
	Name() string
 | 
			
		||||
	Init(opts ...Option) error
 | 
			
		||||
	Options() Options
 | 
			
		||||
	NewMessage(topic string, msg interface{}, opts ...MessageOption) Message
 | 
			
		||||
	NewRequest(service string, endpoint string, req interface{}, opts ...RequestOption) Request
 | 
			
		||||
	Call(ctx context.Context, req Request, rsp interface{}, opts ...CallOption) error
 | 
			
		||||
	Stream(ctx context.Context, req Request, opts ...CallOption) (Stream, error)
 | 
			
		||||
	Publish(ctx context.Context, msg Message, opts ...PublishOption) error
 | 
			
		||||
	String() string
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Message is the interface for publishing asynchronously
 | 
			
		||||
type Message interface {
 | 
			
		||||
	Topic() string
 | 
			
		||||
	Payload() interface{}
 | 
			
		||||
	ContentType() string
 | 
			
		||||
}
 | 
			
		||||
type (
 | 
			
		||||
	FuncCall   func(ctx context.Context, req Request, rsp interface{}, opts ...CallOption) error
 | 
			
		||||
	HookCall   func(next FuncCall) FuncCall
 | 
			
		||||
	FuncStream func(ctx context.Context, req Request, opts ...CallOption) (Stream, error)
 | 
			
		||||
	HookStream func(next FuncStream) FuncStream
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Request is the interface for a synchronous request used by Call or Stream
 | 
			
		||||
type Request interface {
 | 
			
		||||
@@ -72,7 +69,7 @@ type Request interface {
 | 
			
		||||
type Response interface {
 | 
			
		||||
	// Read the response
 | 
			
		||||
	Codec() codec.Codec
 | 
			
		||||
	// read the header
 | 
			
		||||
	// Header data
 | 
			
		||||
	Header() metadata.Metadata
 | 
			
		||||
	// Read the undecoded response
 | 
			
		||||
	Read() ([]byte, error)
 | 
			
		||||
@@ -90,10 +87,16 @@ type Stream interface {
 | 
			
		||||
	Send(msg interface{}) error
 | 
			
		||||
	// Recv will decode and read a response
 | 
			
		||||
	Recv(msg interface{}) error
 | 
			
		||||
	// SendMsg will encode and send a request
 | 
			
		||||
	SendMsg(msg interface{}) error
 | 
			
		||||
	// RecvMsg will decode and read a response
 | 
			
		||||
	RecvMsg(msg interface{}) error
 | 
			
		||||
	// Error returns the stream error
 | 
			
		||||
	Error() error
 | 
			
		||||
	// Close closes the stream
 | 
			
		||||
	Close() error
 | 
			
		||||
	// CloseSend closes the send direction of the stream
 | 
			
		||||
	CloseSend() error
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Option used by the Client
 | 
			
		||||
@@ -102,11 +105,5 @@ type Option func(*Options)
 | 
			
		||||
// CallOption used by Call or Stream
 | 
			
		||||
type CallOption func(*CallOptions)
 | 
			
		||||
 | 
			
		||||
// PublishOption used by Publish
 | 
			
		||||
type PublishOption func(*PublishOptions)
 | 
			
		||||
 | 
			
		||||
// MessageOption used by NewMessage
 | 
			
		||||
type MessageOption func(*MessageOptions)
 | 
			
		||||
 | 
			
		||||
// RequestOption used by NewRequest
 | 
			
		||||
type RequestOption func(*RequestOptions)
 | 
			
		||||
 
 | 
			
		||||
@@ -15,6 +15,15 @@ func FromContext(ctx context.Context) (Client, bool) {
 | 
			
		||||
	return c, ok
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// MustContext get client from context
 | 
			
		||||
func MustContext(ctx context.Context) Client {
 | 
			
		||||
	c, ok := FromContext(ctx)
 | 
			
		||||
	if !ok {
 | 
			
		||||
		panic("missing client")
 | 
			
		||||
	}
 | 
			
		||||
	return c
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewContext put client in context
 | 
			
		||||
func NewContext(ctx context.Context, c Client) context.Context {
 | 
			
		||||
	if ctx == nil {
 | 
			
		||||
@@ -23,16 +32,6 @@ func NewContext(ctx context.Context, c Client) context.Context {
 | 
			
		||||
	return context.WithValue(ctx, clientKey{}, c)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SetPublishOption returns a function to setup a context with given value
 | 
			
		||||
func SetPublishOption(k, v interface{}) PublishOption {
 | 
			
		||||
	return func(o *PublishOptions) {
 | 
			
		||||
		if o.Context == nil {
 | 
			
		||||
			o.Context = context.Background()
 | 
			
		||||
		}
 | 
			
		||||
		o.Context = context.WithValue(o.Context, k, v)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SetCallOption returns a function to setup a context with given value
 | 
			
		||||
func SetCallOption(k, v interface{}) CallOption {
 | 
			
		||||
	return func(o *CallOptions) {
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										62
									
								
								client/context_test.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										62
									
								
								client/context_test.go
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,62 @@
 | 
			
		||||
package client
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"testing"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
func TestFromContext(t *testing.T) {
 | 
			
		||||
	ctx := context.WithValue(context.TODO(), clientKey{}, NewClient())
 | 
			
		||||
 | 
			
		||||
	c, ok := FromContext(ctx)
 | 
			
		||||
	if c == nil || !ok {
 | 
			
		||||
		t.Fatal("FromContext not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestFromNilContext(t *testing.T) {
 | 
			
		||||
	// nolint: staticcheck
 | 
			
		||||
	c, ok := FromContext(nil)
 | 
			
		||||
	if ok || c != nil {
 | 
			
		||||
		t.Fatal("FromContext not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestNewContext(t *testing.T) {
 | 
			
		||||
	ctx := NewContext(context.TODO(), NewClient())
 | 
			
		||||
	c, ok := FromContext(ctx)
 | 
			
		||||
	if c == nil || !ok {
 | 
			
		||||
		t.Fatal("NewContext not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestNewNilContext(t *testing.T) {
 | 
			
		||||
	// nolint: staticcheck
 | 
			
		||||
	ctx := NewContext(nil, NewClient())
 | 
			
		||||
	c, ok := FromContext(ctx)
 | 
			
		||||
	if c == nil || !ok {
 | 
			
		||||
		t.Fatal("NewContext not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestSetCallOption(t *testing.T) {
 | 
			
		||||
	type key struct{}
 | 
			
		||||
	o := SetCallOption(key{}, "test")
 | 
			
		||||
	opts := &CallOptions{}
 | 
			
		||||
	o(opts)
 | 
			
		||||
 | 
			
		||||
	if v, ok := opts.Context.Value(key{}).(string); !ok || v == "" {
 | 
			
		||||
		t.Fatal("SetCallOption not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestSetOption(t *testing.T) {
 | 
			
		||||
	type key struct{}
 | 
			
		||||
	o := SetOption(key{}, "test")
 | 
			
		||||
	opts := &Options{}
 | 
			
		||||
	o(opts)
 | 
			
		||||
 | 
			
		||||
	if v, ok := opts.Context.Value(key{}).(string); !ok || v == "" {
 | 
			
		||||
		t.Fatal("SetOption not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
@@ -4,15 +4,15 @@ import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"sort"
 | 
			
		||||
 | 
			
		||||
	"github.com/unistack-org/micro/v3/errors"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/router"
 | 
			
		||||
	"go.unistack.org/micro/v4/errors"
 | 
			
		||||
	"go.unistack.org/micro/v4/router"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// LookupFunc is used to lookup routes for a service
 | 
			
		||||
type LookupFunc func(context.Context, Request, CallOptions) ([]string, error)
 | 
			
		||||
 | 
			
		||||
// LookupRoute for a request using the router and then choose one using the selector
 | 
			
		||||
func LookupRoute(ctx context.Context, req Request, opts CallOptions) ([]string, error) {
 | 
			
		||||
func LookupRoute(_ context.Context, req Request, opts CallOptions) ([]string, error) {
 | 
			
		||||
	// check to see if an address was provided as a call option
 | 
			
		||||
	if len(opts.Address) > 0 {
 | 
			
		||||
		return opts.Address, nil
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										477
									
								
								client/noop.go
									
									
									
									
									
								
							
							
						
						
									
										477
									
								
								client/noop.go
									
									
									
									
									
								
							@@ -2,56 +2,48 @@ package client
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"fmt"
 | 
			
		||||
	"strconv"
 | 
			
		||||
	"time"
 | 
			
		||||
 | 
			
		||||
	"github.com/unistack-org/micro/v3/broker"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/codec"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/errors"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/metadata"
 | 
			
		||||
	"go.unistack.org/micro/v4/codec"
 | 
			
		||||
	"go.unistack.org/micro/v4/errors"
 | 
			
		||||
	"go.unistack.org/micro/v4/metadata"
 | 
			
		||||
	"go.unistack.org/micro/v4/options"
 | 
			
		||||
	"go.unistack.org/micro/v4/selector"
 | 
			
		||||
	"go.unistack.org/micro/v4/semconv"
 | 
			
		||||
	"go.unistack.org/micro/v4/tracer"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
var (
 | 
			
		||||
	// DefaultCodecs will be used to encode/decode data
 | 
			
		||||
	DefaultCodecs = map[string]codec.Codec{
 | 
			
		||||
		//"application/json":         cjson.NewCodec,
 | 
			
		||||
		//"application/json-rpc":     cjsonrpc.NewCodec,
 | 
			
		||||
		//"application/protobuf":     cproto.NewCodec,
 | 
			
		||||
		//"application/proto-rpc":    cprotorpc.NewCodec,
 | 
			
		||||
		"application/octet-stream": codec.NewCodec(),
 | 
			
		||||
	}
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
type noopClient struct {
 | 
			
		||||
	opts Options
 | 
			
		||||
// DefaultCodecs will be used to encode/decode data
 | 
			
		||||
var DefaultCodecs = map[string]codec.Codec{
 | 
			
		||||
	"application/octet-stream": codec.NewCodec(),
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
type noopMessage struct {
 | 
			
		||||
	topic   string
 | 
			
		||||
	payload interface{}
 | 
			
		||||
	opts    MessageOptions
 | 
			
		||||
type noopClient struct {
 | 
			
		||||
	funcCall   FuncCall
 | 
			
		||||
	funcStream FuncStream
 | 
			
		||||
	opts       Options
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
type noopRequest struct {
 | 
			
		||||
	body        interface{}
 | 
			
		||||
	codec       codec.Codec
 | 
			
		||||
	service     string
 | 
			
		||||
	method      string
 | 
			
		||||
	endpoint    string
 | 
			
		||||
	contentType string
 | 
			
		||||
	body        interface{}
 | 
			
		||||
	codec       codec.Codec
 | 
			
		||||
	stream      bool
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewClient returns new noop client
 | 
			
		||||
func NewClient(opts ...Option) Client {
 | 
			
		||||
	nc := &noopClient{opts: NewOptions(opts...)}
 | 
			
		||||
	// wrap in reverse
 | 
			
		||||
	n := &noopClient{opts: NewOptions(opts...)}
 | 
			
		||||
 | 
			
		||||
	c := Client(nc)
 | 
			
		||||
	n.funcCall = n.fnCall
 | 
			
		||||
	n.funcStream = n.fnStream
 | 
			
		||||
 | 
			
		||||
	for i := len(nc.opts.Wrappers); i > 0; i-- {
 | 
			
		||||
		c = nc.opts.Wrappers[i-1](c)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return c
 | 
			
		||||
	return n
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (n *noopClient) Name() string {
 | 
			
		||||
@@ -103,10 +95,13 @@ func (n *noopResponse) Read() ([]byte, error) {
 | 
			
		||||
	return nil, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
type noopStream struct{}
 | 
			
		||||
type noopStream struct {
 | 
			
		||||
	err error
 | 
			
		||||
	ctx context.Context
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (n *noopStream) Context() context.Context {
 | 
			
		||||
	return context.Background()
 | 
			
		||||
	return n.ctx
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (n *noopStream) Request() Request {
 | 
			
		||||
@@ -125,40 +120,49 @@ func (n *noopStream) Recv(interface{}) error {
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (n *noopStream) Error() error {
 | 
			
		||||
func (n *noopStream) SendMsg(interface{}) error {
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (n *noopStream) RecvMsg(interface{}) error {
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (n *noopStream) Error() error {
 | 
			
		||||
	return n.err
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (n *noopStream) Close() error {
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (n *noopMessage) Topic() string {
 | 
			
		||||
	return n.topic
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (n *noopMessage) Payload() interface{} {
 | 
			
		||||
	return n.payload
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (n *noopMessage) ContentType() string {
 | 
			
		||||
	return n.opts.ContentType
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (n *noopClient) newCodec(contentType string) (codec.Codec, error) {
 | 
			
		||||
	if cf, ok := n.opts.Codecs[contentType]; ok {
 | 
			
		||||
		return cf, nil
 | 
			
		||||
	if sp, ok := tracer.SpanFromContext(n.ctx); ok && sp != nil {
 | 
			
		||||
		if n.err != nil {
 | 
			
		||||
			sp.SetStatus(tracer.SpanStatusError, n.err.Error())
 | 
			
		||||
		}
 | 
			
		||||
		sp.Finish()
 | 
			
		||||
	}
 | 
			
		||||
	if cf, ok := DefaultCodecs[contentType]; ok {
 | 
			
		||||
		return cf, nil
 | 
			
		||||
	}
 | 
			
		||||
	return nil, codec.ErrUnknownContentType
 | 
			
		||||
	return n.err
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (n *noopStream) CloseSend() error {
 | 
			
		||||
	return n.err
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (n *noopClient) Init(opts ...Option) error {
 | 
			
		||||
	for _, o := range opts {
 | 
			
		||||
		o(&n.opts)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	n.funcCall = n.fnCall
 | 
			
		||||
	n.funcStream = n.fnStream
 | 
			
		||||
 | 
			
		||||
	n.opts.Hooks.EachPrev(func(hook options.Hook) {
 | 
			
		||||
		switch h := hook.(type) {
 | 
			
		||||
		case HookCall:
 | 
			
		||||
			n.funcCall = h(n.funcCall)
 | 
			
		||||
		case HookStream:
 | 
			
		||||
			n.funcStream = h(n.funcStream)
 | 
			
		||||
		}
 | 
			
		||||
	})
 | 
			
		||||
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
@@ -171,61 +175,328 @@ func (n *noopClient) String() string {
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (n *noopClient) Call(ctx context.Context, req Request, rsp interface{}, opts ...CallOption) error {
 | 
			
		||||
	return nil
 | 
			
		||||
	ts := time.Now()
 | 
			
		||||
	n.opts.Meter.Counter(semconv.ClientRequestInflight, "endpoint", req.Endpoint()).Inc()
 | 
			
		||||
	var sp tracer.Span
 | 
			
		||||
	ctx, sp = n.opts.Tracer.Start(ctx, "rpc-client",
 | 
			
		||||
		tracer.WithSpanKind(tracer.SpanKindClient),
 | 
			
		||||
		tracer.WithSpanLabels("endpoint", req.Endpoint()),
 | 
			
		||||
	)
 | 
			
		||||
	err := n.funcCall(ctx, req, rsp, opts...)
 | 
			
		||||
	n.opts.Meter.Counter(semconv.ClientRequestInflight, "endpoint", req.Endpoint()).Dec()
 | 
			
		||||
	te := time.Since(ts)
 | 
			
		||||
	n.opts.Meter.Summary(semconv.ClientRequestLatencyMicroseconds, "endpoint", req.Endpoint()).Update(te.Seconds())
 | 
			
		||||
	n.opts.Meter.Histogram(semconv.ClientRequestDurationSeconds, "endpoint", req.Endpoint()).Update(te.Seconds())
 | 
			
		||||
 | 
			
		||||
	if me := errors.FromError(err); me == nil {
 | 
			
		||||
		sp.Finish()
 | 
			
		||||
		n.opts.Meter.Counter(semconv.ClientRequestTotal, "endpoint", req.Endpoint(), "status", "success", "code", strconv.Itoa(int(200))).Inc()
 | 
			
		||||
	} else {
 | 
			
		||||
		sp.SetStatus(tracer.SpanStatusError, err.Error())
 | 
			
		||||
		n.opts.Meter.Counter(semconv.ClientRequestTotal, "endpoint", req.Endpoint(), "status", "failure", "code", strconv.Itoa(int(me.Code))).Inc()
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return err
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (n *noopClient) NewRequest(service, endpoint string, req interface{}, opts ...RequestOption) Request {
 | 
			
		||||
func (n *noopClient) fnCall(ctx context.Context, req Request, rsp interface{}, opts ...CallOption) error {
 | 
			
		||||
	// make a copy of call opts
 | 
			
		||||
	callOpts := n.opts.CallOptions
 | 
			
		||||
	for _, opt := range opts {
 | 
			
		||||
		opt(&callOpts)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// check if we already have a deadline
 | 
			
		||||
	d, ok := ctx.Deadline()
 | 
			
		||||
	if !ok {
 | 
			
		||||
		var cancel context.CancelFunc
 | 
			
		||||
		// no deadline so we create a new one
 | 
			
		||||
		ctx, cancel = context.WithTimeout(ctx, callOpts.RequestTimeout)
 | 
			
		||||
		defer cancel()
 | 
			
		||||
	} else {
 | 
			
		||||
		// got a deadline so no need to setup context
 | 
			
		||||
		// but we need to set the timeout we pass along
 | 
			
		||||
		opt := WithRequestTimeout(time.Until(d))
 | 
			
		||||
		opt(&callOpts)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// should we noop right here?
 | 
			
		||||
	select {
 | 
			
		||||
	case <-ctx.Done():
 | 
			
		||||
		return errors.New("go.micro.client", fmt.Sprintf("%v", ctx.Err()), 408)
 | 
			
		||||
	default:
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// make copy of call method
 | 
			
		||||
	hcall := func(ctx context.Context, addr string, req Request, rsp interface{}, opts CallOptions) error {
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// use the router passed as a call option, or fallback to the rpc clients router
 | 
			
		||||
	if callOpts.Router == nil {
 | 
			
		||||
		callOpts.Router = n.opts.Router
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if callOpts.Selector == nil {
 | 
			
		||||
		callOpts.Selector = n.opts.Selector
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// inject proxy address
 | 
			
		||||
	// TODO: don't even bother using Lookup/Select in this case
 | 
			
		||||
	if len(n.opts.Proxy) > 0 {
 | 
			
		||||
		callOpts.Address = []string{n.opts.Proxy}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	var next selector.Next
 | 
			
		||||
 | 
			
		||||
	// return errors.New("go.micro.client", "request timeout", 408)
 | 
			
		||||
	call := func(i int) error {
 | 
			
		||||
		// call backoff first. Someone may want an initial start delay
 | 
			
		||||
		t, err := callOpts.Backoff(ctx, req, i)
 | 
			
		||||
		if err != nil {
 | 
			
		||||
			return errors.InternalServerError("go.micro.client", "%s", err)
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		// only sleep if greater than 0
 | 
			
		||||
		if t.Seconds() > 0 {
 | 
			
		||||
			time.Sleep(t)
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		if next == nil {
 | 
			
		||||
			var routes []string
 | 
			
		||||
			// lookup the route to send the reques to
 | 
			
		||||
			// TODO apply any filtering here
 | 
			
		||||
			routes, err = n.opts.Lookup(ctx, req, callOpts)
 | 
			
		||||
			if err != nil {
 | 
			
		||||
				return errors.InternalServerError("go.micro.client", "%s", err)
 | 
			
		||||
			}
 | 
			
		||||
 | 
			
		||||
			// balance the list of nodes
 | 
			
		||||
			next, err = callOpts.Selector.Select(routes)
 | 
			
		||||
			if err != nil {
 | 
			
		||||
				return err
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		node := next()
 | 
			
		||||
 | 
			
		||||
		// make the call
 | 
			
		||||
		err = hcall(ctx, node, req, rsp, callOpts)
 | 
			
		||||
		// record the result of the call to inform future routing decisions
 | 
			
		||||
		if verr := n.opts.Selector.Record(node, err); verr != nil {
 | 
			
		||||
			return verr
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		// try and transform the error to a go-micro error
 | 
			
		||||
		if verr, ok := err.(*errors.Error); ok {
 | 
			
		||||
			return verr
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		return err
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	ch := make(chan error, callOpts.Retries)
 | 
			
		||||
	var gerr error
 | 
			
		||||
 | 
			
		||||
	for i := 0; i <= callOpts.Retries; i++ {
 | 
			
		||||
		go func() {
 | 
			
		||||
			ch <- call(i)
 | 
			
		||||
		}()
 | 
			
		||||
 | 
			
		||||
		select {
 | 
			
		||||
		case <-ctx.Done():
 | 
			
		||||
			return errors.New("go.micro.client", fmt.Sprintf("%v", ctx.Err()), 408)
 | 
			
		||||
		case err := <-ch:
 | 
			
		||||
			// if the call succeeded lets bail early
 | 
			
		||||
			if err == nil {
 | 
			
		||||
				return nil
 | 
			
		||||
			}
 | 
			
		||||
 | 
			
		||||
			retry, rerr := callOpts.Retry(ctx, req, i, err)
 | 
			
		||||
			if rerr != nil {
 | 
			
		||||
				return rerr
 | 
			
		||||
			}
 | 
			
		||||
 | 
			
		||||
			if !retry {
 | 
			
		||||
				return err
 | 
			
		||||
			}
 | 
			
		||||
 | 
			
		||||
			gerr = err
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return gerr
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (n *noopClient) NewRequest(service, endpoint string, _ interface{}, _ ...RequestOption) Request {
 | 
			
		||||
	return &noopRequest{service: service, endpoint: endpoint}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (n *noopClient) NewMessage(topic string, msg interface{}, opts ...MessageOption) Message {
 | 
			
		||||
	options := NewMessageOptions(opts...)
 | 
			
		||||
	return &noopMessage{topic: topic, payload: msg, opts: options}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (n *noopClient) Stream(ctx context.Context, req Request, opts ...CallOption) (Stream, error) {
 | 
			
		||||
	return &noopStream{}, nil
 | 
			
		||||
}
 | 
			
		||||
	ts := time.Now()
 | 
			
		||||
	n.opts.Meter.Counter(semconv.ClientRequestInflight, "endpoint", req.Endpoint()).Inc()
 | 
			
		||||
	var sp tracer.Span
 | 
			
		||||
	ctx, sp = n.opts.Tracer.Start(ctx, "rpc-client",
 | 
			
		||||
		tracer.WithSpanKind(tracer.SpanKindClient),
 | 
			
		||||
		tracer.WithSpanLabels("endpoint", req.Endpoint()),
 | 
			
		||||
	)
 | 
			
		||||
	stream, err := n.funcStream(ctx, req, opts...)
 | 
			
		||||
	n.opts.Meter.Counter(semconv.ClientRequestInflight, "endpoint", req.Endpoint()).Dec()
 | 
			
		||||
	te := time.Since(ts)
 | 
			
		||||
	n.opts.Meter.Summary(semconv.ClientRequestLatencyMicroseconds, "endpoint", req.Endpoint()).Update(te.Seconds())
 | 
			
		||||
	n.opts.Meter.Histogram(semconv.ClientRequestDurationSeconds, "endpoint", req.Endpoint()).Update(te.Seconds())
 | 
			
		||||
 | 
			
		||||
func (n *noopClient) Publish(ctx context.Context, p Message, opts ...PublishOption) error {
 | 
			
		||||
	var body []byte
 | 
			
		||||
 | 
			
		||||
	options := NewPublishOptions(opts...)
 | 
			
		||||
 | 
			
		||||
	md, ok := metadata.FromOutgoingContext(ctx)
 | 
			
		||||
	if !ok {
 | 
			
		||||
		md = metadata.New(0)
 | 
			
		||||
	}
 | 
			
		||||
	md["Content-Type"] = p.ContentType()
 | 
			
		||||
	md["Micro-Topic"] = p.Topic()
 | 
			
		||||
 | 
			
		||||
	// passed in raw data
 | 
			
		||||
	if d, ok := p.Payload().(*codec.Frame); ok {
 | 
			
		||||
		body = d.Data
 | 
			
		||||
	if me := errors.FromError(err); me == nil {
 | 
			
		||||
		sp.Finish()
 | 
			
		||||
		n.opts.Meter.Counter(semconv.ClientRequestTotal, "endpoint", req.Endpoint(), "status", "success", "code", strconv.Itoa(int(200))).Inc()
 | 
			
		||||
	} else {
 | 
			
		||||
		// use codec for payload
 | 
			
		||||
		cf, err := n.newCodec(p.ContentType())
 | 
			
		||||
		if err != nil {
 | 
			
		||||
			return errors.InternalServerError("go.micro.client", err.Error())
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		// set the body
 | 
			
		||||
		b, err := cf.Marshal(p.Payload())
 | 
			
		||||
		if err != nil {
 | 
			
		||||
			return errors.InternalServerError("go.micro.client", err.Error())
 | 
			
		||||
		}
 | 
			
		||||
		body = b
 | 
			
		||||
		sp.SetStatus(tracer.SpanStatusError, err.Error())
 | 
			
		||||
		n.opts.Meter.Counter(semconv.ClientRequestTotal, "endpoint", req.Endpoint(), "status", "failure", "code", strconv.Itoa(int(me.Code))).Inc()
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	topic := p.Topic()
 | 
			
		||||
 | 
			
		||||
	// get the exchange
 | 
			
		||||
	if len(options.Exchange) > 0 {
 | 
			
		||||
		topic = options.Exchange
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return n.opts.Broker.Publish(ctx, topic, &broker.Message{
 | 
			
		||||
		Header: md,
 | 
			
		||||
		Body:   body,
 | 
			
		||||
	}, broker.PublishContext(options.Context))
 | 
			
		||||
	return stream, err
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (n *noopClient) fnStream(ctx context.Context, req Request, opts ...CallOption) (Stream, error) {
 | 
			
		||||
	var err error
 | 
			
		||||
 | 
			
		||||
	// make a copy of call opts
 | 
			
		||||
	callOpts := n.opts.CallOptions
 | 
			
		||||
	for _, o := range opts {
 | 
			
		||||
		o(&callOpts)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// check if we already have a deadline
 | 
			
		||||
	d, ok := ctx.Deadline()
 | 
			
		||||
	if !ok && callOpts.StreamTimeout > time.Duration(0) {
 | 
			
		||||
		var cancel context.CancelFunc
 | 
			
		||||
		// no deadline so we create a new one
 | 
			
		||||
		ctx, cancel = context.WithTimeout(ctx, callOpts.StreamTimeout)
 | 
			
		||||
		defer cancel()
 | 
			
		||||
	} else {
 | 
			
		||||
		// got a deadline so no need to setup context
 | 
			
		||||
		// but we need to set the timeout we pass along
 | 
			
		||||
		o := WithStreamTimeout(time.Until(d))
 | 
			
		||||
		o(&callOpts)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// should we noop right here?
 | 
			
		||||
	select {
 | 
			
		||||
	case <-ctx.Done():
 | 
			
		||||
		return nil, errors.New("go.micro.client", fmt.Sprintf("%v", ctx.Err()), 408)
 | 
			
		||||
	default:
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	/*
 | 
			
		||||
		// make copy of call method
 | 
			
		||||
		hstream := h.stream
 | 
			
		||||
		// wrap the call in reverse
 | 
			
		||||
		for i := len(callOpts.CallWrappers); i > 0; i-- {
 | 
			
		||||
			hstream = callOpts.CallWrappers[i-1](hstream)
 | 
			
		||||
		}
 | 
			
		||||
	*/
 | 
			
		||||
 | 
			
		||||
	// use the router passed as a call option, or fallback to the rpc clients router
 | 
			
		||||
	if callOpts.Router == nil {
 | 
			
		||||
		callOpts.Router = n.opts.Router
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if callOpts.Selector == nil {
 | 
			
		||||
		callOpts.Selector = n.opts.Selector
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// inject proxy address
 | 
			
		||||
	// TODO: don't even bother using Lookup/Select in this case
 | 
			
		||||
	if len(n.opts.Proxy) > 0 {
 | 
			
		||||
		callOpts.Address = []string{n.opts.Proxy}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	var next selector.Next
 | 
			
		||||
 | 
			
		||||
	call := func(i int) (Stream, error) {
 | 
			
		||||
		// call backoff first. Someone may want an initial start delay
 | 
			
		||||
		t, cerr := callOpts.Backoff(ctx, req, i)
 | 
			
		||||
		if cerr != nil {
 | 
			
		||||
			return nil, errors.InternalServerError("go.micro.client", "%s", cerr)
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		// only sleep if greater than 0
 | 
			
		||||
		if t.Seconds() > 0 {
 | 
			
		||||
			time.Sleep(t)
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		if next == nil {
 | 
			
		||||
			var routes []string
 | 
			
		||||
			// lookup the route to send the reques to
 | 
			
		||||
			// TODO apply any filtering here
 | 
			
		||||
			routes, err = n.opts.Lookup(ctx, req, callOpts)
 | 
			
		||||
			if err != nil {
 | 
			
		||||
				return nil, errors.InternalServerError("go.micro.client", "%s", err)
 | 
			
		||||
			}
 | 
			
		||||
 | 
			
		||||
			// balance the list of nodes
 | 
			
		||||
			next, err = callOpts.Selector.Select(routes)
 | 
			
		||||
			if err != nil {
 | 
			
		||||
				return nil, err
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		node := next()
 | 
			
		||||
 | 
			
		||||
		stream, cerr := n.stream(ctx, node, req, callOpts)
 | 
			
		||||
 | 
			
		||||
		// record the result of the call to inform future routing decisions
 | 
			
		||||
		if verr := n.opts.Selector.Record(node, cerr); verr != nil {
 | 
			
		||||
			return nil, verr
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		// try and transform the error to a go-micro error
 | 
			
		||||
		if verr, ok := cerr.(*errors.Error); ok {
 | 
			
		||||
			return nil, verr
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		return stream, cerr
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	type response struct {
 | 
			
		||||
		stream Stream
 | 
			
		||||
		err    error
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	ch := make(chan response, callOpts.Retries)
 | 
			
		||||
	var grr error
 | 
			
		||||
 | 
			
		||||
	for i := 0; i <= callOpts.Retries; i++ {
 | 
			
		||||
		go func() {
 | 
			
		||||
			s, cerr := call(i)
 | 
			
		||||
			ch <- response{s, cerr}
 | 
			
		||||
		}()
 | 
			
		||||
 | 
			
		||||
		select {
 | 
			
		||||
		case <-ctx.Done():
 | 
			
		||||
			return nil, errors.New("go.micro.client", fmt.Sprintf("%v", ctx.Err()), 408)
 | 
			
		||||
		case rsp := <-ch:
 | 
			
		||||
			// if the call succeeded lets bail early
 | 
			
		||||
			if rsp.err == nil {
 | 
			
		||||
				return rsp.stream, nil
 | 
			
		||||
			}
 | 
			
		||||
 | 
			
		||||
			retry, rerr := callOpts.Retry(ctx, req, i, err)
 | 
			
		||||
			if rerr != nil {
 | 
			
		||||
				return nil, rerr
 | 
			
		||||
			}
 | 
			
		||||
 | 
			
		||||
			if !retry {
 | 
			
		||||
				return nil, rsp.err
 | 
			
		||||
			}
 | 
			
		||||
 | 
			
		||||
			grr = rsp.err
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return nil, grr
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (n *noopClient) stream(ctx context.Context, _ string, _ Request, _ CallOptions) (Stream, error) {
 | 
			
		||||
	return &noopStream{ctx: ctx}, nil
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -2,51 +2,71 @@ package client
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"crypto/tls"
 | 
			
		||||
	"net"
 | 
			
		||||
	"time"
 | 
			
		||||
 | 
			
		||||
	"github.com/unistack-org/micro/v3/broker"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/codec"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/logger"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/meter"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/network/transport"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/register"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/router"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/selector"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/selector/random"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/tracer"
 | 
			
		||||
	"go.unistack.org/micro/v4/broker"
 | 
			
		||||
	"go.unistack.org/micro/v4/codec"
 | 
			
		||||
	"go.unistack.org/micro/v4/logger"
 | 
			
		||||
	"go.unistack.org/micro/v4/metadata"
 | 
			
		||||
	"go.unistack.org/micro/v4/meter"
 | 
			
		||||
	"go.unistack.org/micro/v4/options"
 | 
			
		||||
	"go.unistack.org/micro/v4/register"
 | 
			
		||||
	"go.unistack.org/micro/v4/router"
 | 
			
		||||
	"go.unistack.org/micro/v4/selector"
 | 
			
		||||
	"go.unistack.org/micro/v4/selector/random"
 | 
			
		||||
	"go.unistack.org/micro/v4/tracer"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Options holds client options
 | 
			
		||||
type Options struct {
 | 
			
		||||
	Name string
 | 
			
		||||
	// Used to select codec
 | 
			
		||||
	ContentType string
 | 
			
		||||
	// Proxy address to send requests via
 | 
			
		||||
	// Codecs map
 | 
			
		||||
	Codecs map[string]codec.Codec
 | 
			
		||||
 | 
			
		||||
	// Proxy is used for proxy requests
 | 
			
		||||
	Proxy string
 | 
			
		||||
	// ContentType is used to select codec
 | 
			
		||||
	ContentType string
 | 
			
		||||
	// Name is the client name
 | 
			
		||||
	Name string
 | 
			
		||||
 | 
			
		||||
	// Plugged interfaces
 | 
			
		||||
	Broker    broker.Broker
 | 
			
		||||
	Codecs    map[string]codec.Codec
 | 
			
		||||
	Router    router.Router
 | 
			
		||||
	Selector  selector.Selector
 | 
			
		||||
	Transport transport.Transport
 | 
			
		||||
	Logger    logger.Logger
 | 
			
		||||
	Meter     meter.Meter
 | 
			
		||||
	// Lookup used for looking up routes
 | 
			
		||||
	// Selector used to select needed address
 | 
			
		||||
	Selector selector.Selector
 | 
			
		||||
	// Logger used to log messages
 | 
			
		||||
	Logger logger.Logger
 | 
			
		||||
	// Tracer used for tracing
 | 
			
		||||
	Tracer tracer.Tracer
 | 
			
		||||
	// Broker used to publish messages
 | 
			
		||||
	Broker broker.Broker
 | 
			
		||||
	// Meter used for metrics
 | 
			
		||||
	Meter meter.Meter
 | 
			
		||||
	// Context is used for external options
 | 
			
		||||
	Context context.Context
 | 
			
		||||
	// Router used to get route
 | 
			
		||||
	Router router.Router
 | 
			
		||||
 | 
			
		||||
	// TLSConfig specifies tls.Config for secure connection
 | 
			
		||||
	TLSConfig *tls.Config
 | 
			
		||||
 | 
			
		||||
	// Lookup func used to get destination addr
 | 
			
		||||
	Lookup LookupFunc
 | 
			
		||||
	// ContextDialer used to connect
 | 
			
		||||
	ContextDialer func(context.Context, string) (net.Conn, error)
 | 
			
		||||
 | 
			
		||||
	// Connection Pool
 | 
			
		||||
	PoolSize int
 | 
			
		||||
	PoolTTL  time.Duration
 | 
			
		||||
	Tracer   tracer.Tracer
 | 
			
		||||
	// Wrapper that used client
 | 
			
		||||
	// Wrappers contains wrappers
 | 
			
		||||
	Wrappers []Wrapper
 | 
			
		||||
	// Hooks can be run before broker Publish/BatchPublish and
 | 
			
		||||
	// Subscribe/BatchSubscribe methods
 | 
			
		||||
	Hooks options.Hooks
 | 
			
		||||
 | 
			
		||||
	// CallOptions that used by default
 | 
			
		||||
	// CallOptions contains default CallOptions
 | 
			
		||||
	CallOptions CallOptions
 | 
			
		||||
 | 
			
		||||
	// Context is used for non default options
 | 
			
		||||
	Context context.Context
 | 
			
		||||
	// PoolSize connection pool size
 | 
			
		||||
	PoolSize int
 | 
			
		||||
	// PoolTTL connection pool ttl
 | 
			
		||||
	PoolTTL time.Duration
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewCallOptions creates new call options struct
 | 
			
		||||
@@ -60,34 +80,54 @@ func NewCallOptions(opts ...CallOption) CallOptions {
 | 
			
		||||
 | 
			
		||||
// CallOptions holds client call options
 | 
			
		||||
type CallOptions struct {
 | 
			
		||||
	// Address of remote hosts
 | 
			
		||||
	Address []string
 | 
			
		||||
	// Backoff func
 | 
			
		||||
	Backoff BackoffFunc
 | 
			
		||||
	// DialTimeout is the transport Dial Timeout
 | 
			
		||||
	DialTimeout time.Duration
 | 
			
		||||
	// Retries is the number of Call attempts
 | 
			
		||||
	Retries int
 | 
			
		||||
	// Retry func to be used for retries
 | 
			
		||||
	Retry RetryFunc
 | 
			
		||||
	// RequestTimeout specifies request timeout
 | 
			
		||||
	RequestTimeout time.Duration
 | 
			
		||||
	// Router to use for this call
 | 
			
		||||
	Router router.Router
 | 
			
		||||
	// Selector to use for the call
 | 
			
		||||
	Selector selector.Selector
 | 
			
		||||
	// SelectOptions to use when selecting a route
 | 
			
		||||
	SelectOptions []selector.SelectOption
 | 
			
		||||
	// StreamTimeout timeout for the stream
 | 
			
		||||
	StreamTimeout time.Duration
 | 
			
		||||
	// AuthToken specifies the auth token as the authorization header
 | 
			
		||||
	AuthToken bool
 | 
			
		||||
	// Network to lookup the route within
 | 
			
		||||
	// RequestMetadata holds additional metadata for call
 | 
			
		||||
	RequestMetadata metadata.Metadata
 | 
			
		||||
 | 
			
		||||
	// Network name
 | 
			
		||||
	Network string
 | 
			
		||||
	// CallWrappers is for low level call func
 | 
			
		||||
	CallWrappers []CallWrapper
 | 
			
		||||
	// Context is used for non default options
 | 
			
		||||
	// Content-Type
 | 
			
		||||
	ContentType string
 | 
			
		||||
	// AuthToken string
 | 
			
		||||
	AuthToken string
 | 
			
		||||
 | 
			
		||||
	// Selector selects addr
 | 
			
		||||
	Selector selector.Selector
 | 
			
		||||
	// Context used for deadline
 | 
			
		||||
	Context context.Context
 | 
			
		||||
	// Router used for route
 | 
			
		||||
	Router router.Router
 | 
			
		||||
	// Retry func used for retries
 | 
			
		||||
 | 
			
		||||
	// ResponseMetadata holds additional metadata from call
 | 
			
		||||
	ResponseMetadata *metadata.Metadata
 | 
			
		||||
 | 
			
		||||
	Retry RetryFunc
 | 
			
		||||
	// Backoff func used for backoff when retry
 | 
			
		||||
	Backoff BackoffFunc
 | 
			
		||||
	// ContextDialer used to connect
 | 
			
		||||
	ContextDialer func(context.Context, string) (net.Conn, error)
 | 
			
		||||
 | 
			
		||||
	// Address specifies static addr list
 | 
			
		||||
	Address []string
 | 
			
		||||
	// SelectOptions selector options
 | 
			
		||||
	SelectOptions []selector.SelectOption
 | 
			
		||||
 | 
			
		||||
	// StreamTimeout stream timeout
 | 
			
		||||
	StreamTimeout time.Duration
 | 
			
		||||
	// RequestTimeout request timeout
 | 
			
		||||
	RequestTimeout time.Duration
 | 
			
		||||
 | 
			
		||||
	// DialTimeout dial timeout
 | 
			
		||||
	DialTimeout time.Duration
 | 
			
		||||
	// Retries specifies retries num
 | 
			
		||||
	Retries int
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// ContextDialer pass ContextDialer to client
 | 
			
		||||
func ContextDialer(fn func(context.Context, string) (net.Conn, error)) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.ContextDialer = fn
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Context pass context to client
 | 
			
		||||
@@ -97,37 +137,6 @@ func Context(ctx context.Context) Option {
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewPublishOptions create new PublishOptions struct from option
 | 
			
		||||
func NewPublishOptions(opts ...PublishOption) PublishOptions {
 | 
			
		||||
	options := PublishOptions{}
 | 
			
		||||
	for _, o := range opts {
 | 
			
		||||
		o(&options)
 | 
			
		||||
	}
 | 
			
		||||
	return options
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// PublishOptions holds publish options
 | 
			
		||||
type PublishOptions struct {
 | 
			
		||||
	// Exchange is the routing exchange for the message
 | 
			
		||||
	Exchange string
 | 
			
		||||
	// Context holds additional options
 | 
			
		||||
	Context context.Context
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewMessageOptions creates message options struct
 | 
			
		||||
func NewMessageOptions(opts ...MessageOption) MessageOptions {
 | 
			
		||||
	options := MessageOptions{}
 | 
			
		||||
	for _, o := range opts {
 | 
			
		||||
		o(&options)
 | 
			
		||||
	}
 | 
			
		||||
	return options
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// MessageOptions holds client message options
 | 
			
		||||
type MessageOptions struct {
 | 
			
		||||
	ContentType string
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewRequestOptions creates new RequestOptions struct
 | 
			
		||||
func NewRequestOptions(opts ...RequestOption) RequestOptions {
 | 
			
		||||
	options := RequestOptions{}
 | 
			
		||||
@@ -139,12 +148,12 @@ func NewRequestOptions(opts ...RequestOption) RequestOptions {
 | 
			
		||||
 | 
			
		||||
// RequestOptions holds client request options
 | 
			
		||||
type RequestOptions struct {
 | 
			
		||||
	// ContentType specify content-type of request
 | 
			
		||||
	ContentType string
 | 
			
		||||
	// Stream says that request is the streaming
 | 
			
		||||
	Stream bool
 | 
			
		||||
	// Context can hold other options
 | 
			
		||||
	// Context used for external options
 | 
			
		||||
	Context context.Context
 | 
			
		||||
	// ContentType specify content-type of message
 | 
			
		||||
	ContentType string
 | 
			
		||||
	// Stream flag
 | 
			
		||||
	Stream bool
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewOptions creates new options struct
 | 
			
		||||
@@ -152,13 +161,13 @@ func NewOptions(opts ...Option) Options {
 | 
			
		||||
	options := Options{
 | 
			
		||||
		Context:     context.Background(),
 | 
			
		||||
		ContentType: DefaultContentType,
 | 
			
		||||
		Codecs:      make(map[string]codec.Codec),
 | 
			
		||||
		Codecs:      DefaultCodecs,
 | 
			
		||||
		CallOptions: CallOptions{
 | 
			
		||||
			Context:        context.Background(),
 | 
			
		||||
			Backoff:        DefaultBackoff,
 | 
			
		||||
			Retry:          DefaultRetry,
 | 
			
		||||
			Retries:        DefaultRetries,
 | 
			
		||||
			RequestTimeout: DefaultRequestTimeout,
 | 
			
		||||
			DialTimeout:    transport.DefaultDialTimeout,
 | 
			
		||||
		},
 | 
			
		||||
		Lookup:   LookupRoute,
 | 
			
		||||
		PoolSize: DefaultPoolSize,
 | 
			
		||||
@@ -168,6 +177,7 @@ func NewOptions(opts ...Option) Options {
 | 
			
		||||
		Broker:   broker.DefaultBroker,
 | 
			
		||||
		Meter:    meter.DefaultMeter,
 | 
			
		||||
		Tracer:   tracer.DefaultTracer,
 | 
			
		||||
		Router:   router.DefaultRouter,
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	for _, o := range opts {
 | 
			
		||||
@@ -240,18 +250,11 @@ func PoolTTL(d time.Duration) Option {
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Transport to use for communication e.g http, rabbitmq, etc
 | 
			
		||||
func Transport(t transport.Transport) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.Transport = t
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Register sets the routers register
 | 
			
		||||
func Register(r register.Register) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		if o.Router != nil {
 | 
			
		||||
			o.Router.Init(router.Register(r))
 | 
			
		||||
			_ = o.Router.Init(router.Register(r))
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
@@ -270,20 +273,6 @@ func Selector(s selector.Selector) Option {
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Wrap adds a wrapper to the list of options passed into the client
 | 
			
		||||
func Wrap(w Wrapper) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.Wrappers = append(o.Wrappers, w)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WrapCall adds a wrapper to the list of CallFunc wrappers
 | 
			
		||||
func WrapCall(cw ...CallWrapper) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.CallOptions.CallWrappers = append(o.CallOptions.CallWrappers, cw...)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Backoff is used to set the backoff function used when retrying Calls
 | 
			
		||||
func Backoff(fn BackoffFunc) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
@@ -305,6 +294,14 @@ func Lookup(l LookupFunc) Option {
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// TLSConfig specifies a *tls.Config
 | 
			
		||||
func TLSConfig(t *tls.Config) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		// set the internal tls
 | 
			
		||||
		o.TLSConfig = t
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Retries sets the retry count when making the request.
 | 
			
		||||
func Retries(i int) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
@@ -340,17 +337,17 @@ func DialTimeout(d time.Duration) Option {
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithExchange sets the exchange to route a message through
 | 
			
		||||
func WithExchange(e string) PublishOption {
 | 
			
		||||
	return func(o *PublishOptions) {
 | 
			
		||||
		o.Exchange = e
 | 
			
		||||
// WithContextDialer pass ContextDialer to client call
 | 
			
		||||
func WithContextDialer(fn func(context.Context, string) (net.Conn, error)) CallOption {
 | 
			
		||||
	return func(o *CallOptions) {
 | 
			
		||||
		o.ContextDialer = fn
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// PublishContext sets the context in publish options
 | 
			
		||||
func PublishContext(ctx context.Context) PublishOption {
 | 
			
		||||
	return func(o *PublishOptions) {
 | 
			
		||||
		o.Context = ctx
 | 
			
		||||
// WithContentType specifies call content type
 | 
			
		||||
func WithContentType(ct string) CallOption {
 | 
			
		||||
	return func(o *CallOptions) {
 | 
			
		||||
		o.ContentType = ct
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
@@ -361,13 +358,6 @@ func WithAddress(a ...string) CallOption {
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithCallWrapper is a CallOption which adds to the existing CallFunc wrappers
 | 
			
		||||
func WithCallWrapper(cw ...CallWrapper) CallOption {
 | 
			
		||||
	return func(o *CallOptions) {
 | 
			
		||||
		o.CallWrappers = append(o.CallWrappers, cw...)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithBackoff is a CallOption which overrides that which
 | 
			
		||||
// set in Options.CallOptions
 | 
			
		||||
func WithBackoff(fn BackoffFunc) CallOption {
 | 
			
		||||
@@ -392,6 +382,20 @@ func WithRetries(i int) CallOption {
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithResponseMetadata is a CallOption which adds metadata.Metadata to Options.CallOptions
 | 
			
		||||
func WithResponseMetadata(md *metadata.Metadata) CallOption {
 | 
			
		||||
	return func(o *CallOptions) {
 | 
			
		||||
		o.ResponseMetadata = md
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithRequestMetadata is a CallOption which adds metadata.Metadata to Options.CallOptions
 | 
			
		||||
func WithRequestMetadata(md metadata.Metadata) CallOption {
 | 
			
		||||
	return func(o *CallOptions) {
 | 
			
		||||
		o.RequestMetadata = md
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithRequestTimeout is a CallOption which overrides that which
 | 
			
		||||
// set in Options.CallOptions
 | 
			
		||||
func WithRequestTimeout(d time.Duration) CallOption {
 | 
			
		||||
@@ -417,16 +421,9 @@ func WithDialTimeout(d time.Duration) CallOption {
 | 
			
		||||
 | 
			
		||||
// WithAuthToken is a CallOption which overrides the
 | 
			
		||||
// authorization header with the services own auth token
 | 
			
		||||
func WithAuthToken() CallOption {
 | 
			
		||||
func WithAuthToken(t string) CallOption {
 | 
			
		||||
	return func(o *CallOptions) {
 | 
			
		||||
		o.AuthToken = true
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithNetwork is a CallOption which sets the network attribute
 | 
			
		||||
func WithNetwork(n string) CallOption {
 | 
			
		||||
	return func(o *CallOptions) {
 | 
			
		||||
		o.Network = n
 | 
			
		||||
		o.AuthToken = t
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
@@ -451,23 +448,23 @@ func WithSelectOptions(sops ...selector.SelectOption) CallOption {
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithMessageContentType sets the message content type
 | 
			
		||||
func WithMessageContentType(ct string) MessageOption {
 | 
			
		||||
	return func(o *MessageOptions) {
 | 
			
		||||
		o.ContentType = ct
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WithContentType specifies request content type
 | 
			
		||||
func WithContentType(ct string) RequestOption {
 | 
			
		||||
	return func(o *RequestOptions) {
 | 
			
		||||
		o.ContentType = ct
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// StreamingRequest specifies that request is streaming
 | 
			
		||||
func StreamingRequest() RequestOption {
 | 
			
		||||
func StreamingRequest(b bool) RequestOption {
 | 
			
		||||
	return func(o *RequestOptions) {
 | 
			
		||||
		o.Stream = true
 | 
			
		||||
		o.Stream = b
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// RequestContentType specifies request content type
 | 
			
		||||
func RequestContentType(ct string) RequestOption {
 | 
			
		||||
	return func(o *RequestOptions) {
 | 
			
		||||
		o.ContentType = ct
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Hooks sets hook runs before action
 | 
			
		||||
func Hooks(h ...options.Hook) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.Hooks = append(o.Hooks, h...)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -3,7 +3,7 @@ package client
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
 | 
			
		||||
	"github.com/unistack-org/micro/v3/errors"
 | 
			
		||||
	"go.unistack.org/micro/v4/errors"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// RetryFunc that returning either false or a non-nil error will result in the call not being retried
 | 
			
		||||
@@ -19,18 +19,32 @@ func RetryNever(ctx context.Context, req Request, retryCount int, err error) (bo
 | 
			
		||||
	return false, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// RetryOnError retries a request on a 500 or timeout error
 | 
			
		||||
func RetryOnError(ctx context.Context, req Request, retryCount int, err error) (bool, error) {
 | 
			
		||||
// RetryOnError retries a request on a 500 or 408 (timeout) error
 | 
			
		||||
func RetryOnError(_ context.Context, _ Request, _ int, err error) (bool, error) {
 | 
			
		||||
	if err == nil {
 | 
			
		||||
		return false, nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	me := errors.FromError(err)
 | 
			
		||||
	switch me.Code {
 | 
			
		||||
	// retry on timeout or internal server error
 | 
			
		||||
	case 408, 500:
 | 
			
		||||
		return true, nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return false, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// RetryOnErrors retries a request on specified error codes
 | 
			
		||||
func RetryOnErrors(codes ...int32) RetryFunc {
 | 
			
		||||
	return func(_ context.Context, _ Request, _ int, err error) (bool, error) {
 | 
			
		||||
		if err == nil {
 | 
			
		||||
			return false, nil
 | 
			
		||||
		}
 | 
			
		||||
		me := errors.FromError(err)
 | 
			
		||||
		for _, code := range codes {
 | 
			
		||||
			if me.Code == code {
 | 
			
		||||
				return true, nil
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
		return false, nil
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										70
									
								
								client/retry_test.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										70
									
								
								client/retry_test.go
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,70 @@
 | 
			
		||||
package client
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"fmt"
 | 
			
		||||
	"testing"
 | 
			
		||||
 | 
			
		||||
	"go.unistack.org/micro/v4/errors"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
func TestRetryAlways(t *testing.T) {
 | 
			
		||||
	tests := []error{
 | 
			
		||||
		nil,
 | 
			
		||||
		errors.InternalServerError("test", "%s", "test"),
 | 
			
		||||
		fmt.Errorf("test"),
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	for _, e := range tests {
 | 
			
		||||
		ok, er := RetryAlways(context.TODO(), nil, 1, e)
 | 
			
		||||
		if !ok || er != nil {
 | 
			
		||||
			t.Fatal("RetryAlways not works properly")
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestRetryNever(t *testing.T) {
 | 
			
		||||
	tests := []error{
 | 
			
		||||
		nil,
 | 
			
		||||
		errors.InternalServerError("test", "%s", "test"),
 | 
			
		||||
		fmt.Errorf("test"),
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	for _, e := range tests {
 | 
			
		||||
		ok, er := RetryNever(context.TODO(), nil, 1, e)
 | 
			
		||||
		if ok || er != nil {
 | 
			
		||||
			t.Fatal("RetryNever not works properly")
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestRetryOnError(t *testing.T) {
 | 
			
		||||
	tests := []error{
 | 
			
		||||
		fmt.Errorf("test"),
 | 
			
		||||
		errors.NotFound("test", "%s", "test"),
 | 
			
		||||
		errors.Timeout("test", "%s", "test"),
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	for i, e := range tests {
 | 
			
		||||
		ok, er := RetryOnError(context.TODO(), nil, 1, e)
 | 
			
		||||
		if i == 2 && (!ok || er != nil) {
 | 
			
		||||
			t.Fatal("RetryOnError not works properly")
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestRetryOnErrors(t *testing.T) {
 | 
			
		||||
	tests := []error{
 | 
			
		||||
		fmt.Errorf("test"),
 | 
			
		||||
		errors.NotFound("test", "%s", "test"),
 | 
			
		||||
		errors.Timeout("test", "%s", "test"),
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	fn := RetryOnErrors(404)
 | 
			
		||||
	for i, e := range tests {
 | 
			
		||||
		ok, er := fn(context.TODO(), nil, 1, e)
 | 
			
		||||
		if i == 1 && (!ok || er != nil) {
 | 
			
		||||
			t.Fatal("RetryOnErrors not works properly")
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
@@ -1,16 +1,16 @@
 | 
			
		||||
package client
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"github.com/unistack-org/micro/v3/codec"
 | 
			
		||||
	"go.unistack.org/micro/v4/codec"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
type testRequest struct {
 | 
			
		||||
	codec       codec.Codec
 | 
			
		||||
	body        interface{}
 | 
			
		||||
	service     string
 | 
			
		||||
	method      string
 | 
			
		||||
	endpoint    string
 | 
			
		||||
	contentType string
 | 
			
		||||
	codec       codec.Codec
 | 
			
		||||
	body        interface{}
 | 
			
		||||
	opts        RequestOptions
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										47
									
								
								cluster/cluster.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										47
									
								
								cluster/cluster.go
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,47 @@
 | 
			
		||||
package cluster
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
 | 
			
		||||
	"go.unistack.org/micro/v4/metadata"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Message sent to member in cluster
 | 
			
		||||
type Message interface {
 | 
			
		||||
	// Header returns message headers
 | 
			
		||||
	Header() metadata.Metadata
 | 
			
		||||
	// Body returns broker message may be []byte slice or some go struct or interface
 | 
			
		||||
	Body() interface{}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
type Node interface {
 | 
			
		||||
	// Name returns node name
 | 
			
		||||
	Name() string
 | 
			
		||||
	// Address returns node address
 | 
			
		||||
	Address() string
 | 
			
		||||
	// Metadata returns node metadata
 | 
			
		||||
	Metadata() metadata.Metadata
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Cluster interface used for cluster communication across nodes
 | 
			
		||||
type Cluster interface {
 | 
			
		||||
	// Join is used to take an existing members and performing state sync
 | 
			
		||||
	Join(ctx context.Context, addr ...string) error
 | 
			
		||||
	// Leave broadcast a leave message and stop listeners
 | 
			
		||||
	Leave(ctx context.Context) error
 | 
			
		||||
	// Ping is used to probe live status of the node
 | 
			
		||||
	Ping(ctx context.Context, node Node, payload []byte) error
 | 
			
		||||
	// Members returns the cluster members
 | 
			
		||||
	Members() ([]Node, error)
 | 
			
		||||
	// Broadcast send message for all members in cluster, if filter is not nil, nodes may be filtered
 | 
			
		||||
	// by key/value pairs
 | 
			
		||||
	Broadcast(ctx context.Context, msg Message, filter ...string) error
 | 
			
		||||
	// Unicast send message to single member in cluster
 | 
			
		||||
	Unicast(ctx context.Context, node Node, msg Message) error
 | 
			
		||||
	// Live returns cluster liveness
 | 
			
		||||
	Live() bool
 | 
			
		||||
	// Ready returns cluster readiness
 | 
			
		||||
	Ready() bool
 | 
			
		||||
	// Health returns cluster health
 | 
			
		||||
	Health() bool
 | 
			
		||||
}
 | 
			
		||||
@@ -3,17 +3,8 @@ package codec
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"errors"
 | 
			
		||||
	"io"
 | 
			
		||||
 | 
			
		||||
	"github.com/unistack-org/micro/v3/metadata"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Message types
 | 
			
		||||
const (
 | 
			
		||||
	Error MessageType = iota
 | 
			
		||||
	Request
 | 
			
		||||
	Response
 | 
			
		||||
	Event
 | 
			
		||||
	"gopkg.in/yaml.v3"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
var (
 | 
			
		||||
@@ -24,46 +15,63 @@ var (
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
var (
 | 
			
		||||
	// DefaultMaxMsgSize specifies how much data codec can handle
 | 
			
		||||
	DefaultMaxMsgSize int = 1024 * 1024 * 4 // 4Mb
 | 
			
		||||
	// DefaultCodec is the global default codec
 | 
			
		||||
	DefaultCodec Codec = NewCodec()
 | 
			
		||||
	DefaultCodec = NewCodec()
 | 
			
		||||
	// DefaultTagName specifies struct tag name to control codec Marshal/Unmarshal
 | 
			
		||||
	DefaultTagName = "codec"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// MessageType specifies message type for codec
 | 
			
		||||
type MessageType int
 | 
			
		||||
 | 
			
		||||
// Codec encodes/decodes various types of messages used within micro.
 | 
			
		||||
// ReadHeader and ReadBody are called in pairs to read requests/responses
 | 
			
		||||
// from the connection. Close is called when finished with the
 | 
			
		||||
// connection. ReadBody may be called with a nil argument to force the
 | 
			
		||||
// body to be read and discarded.
 | 
			
		||||
// Codec encodes/decodes various types of messages.
 | 
			
		||||
type Codec interface {
 | 
			
		||||
	ReadHeader(io.Reader, *Message, MessageType) error
 | 
			
		||||
	ReadBody(io.Reader, interface{}) error
 | 
			
		||||
	Write(io.Writer, *Message, interface{}) error
 | 
			
		||||
	Marshal(interface{}) ([]byte, error)
 | 
			
		||||
	Unmarshal([]byte, interface{}) error
 | 
			
		||||
	Marshal(v interface{}, opts ...Option) ([]byte, error)
 | 
			
		||||
	Unmarshal(b []byte, v interface{}, opts ...Option) error
 | 
			
		||||
	String() string
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Message represents detailed information about
 | 
			
		||||
// the communication, likely followed by the body.
 | 
			
		||||
// In the case of an error, body may be nil.
 | 
			
		||||
type Message struct {
 | 
			
		||||
	Id       string
 | 
			
		||||
	Type     MessageType
 | 
			
		||||
	Target   string
 | 
			
		||||
	Method   string
 | 
			
		||||
	Endpoint string
 | 
			
		||||
	Error    string
 | 
			
		||||
 | 
			
		||||
	// The values read from the socket
 | 
			
		||||
	Header metadata.Metadata
 | 
			
		||||
	Body   []byte
 | 
			
		||||
type CodecV2 interface {
 | 
			
		||||
	Marshal(buf []byte, v interface{}, opts ...Option) ([]byte, error)
 | 
			
		||||
	Unmarshal(buf []byte, v interface{}, opts ...Option) error
 | 
			
		||||
	String() string
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewMessage creates new codec message
 | 
			
		||||
func NewMessage(t MessageType) *Message {
 | 
			
		||||
	return &Message{Type: t, Header: metadata.New(0)}
 | 
			
		||||
// RawMessage is a raw encoded JSON value.
 | 
			
		||||
// It implements Marshaler and Unmarshaler and can be used to delay decoding or precompute a encoding.
 | 
			
		||||
type RawMessage []byte
 | 
			
		||||
 | 
			
		||||
// MarshalJSON returns m as the JSON encoding of m.
 | 
			
		||||
func (m *RawMessage) MarshalJSON() ([]byte, error) {
 | 
			
		||||
	if m == nil {
 | 
			
		||||
		return []byte("null"), nil
 | 
			
		||||
	} else if len(*m) == 0 {
 | 
			
		||||
		return []byte("null"), nil
 | 
			
		||||
	}
 | 
			
		||||
	return *m, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// UnmarshalJSON sets *m to a copy of data.
 | 
			
		||||
func (m *RawMessage) UnmarshalJSON(data []byte) error {
 | 
			
		||||
	if m == nil {
 | 
			
		||||
		return errors.New("RawMessage UnmarshalJSON on nil pointer")
 | 
			
		||||
	}
 | 
			
		||||
	*m = append((*m)[0:0], data...)
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// MarshalYAML returns m as the JSON encoding of m.
 | 
			
		||||
func (m *RawMessage) MarshalYAML() ([]byte, error) {
 | 
			
		||||
	if m == nil {
 | 
			
		||||
		return []byte("null"), nil
 | 
			
		||||
	} else if len(*m) == 0 {
 | 
			
		||||
		return []byte("null"), nil
 | 
			
		||||
	}
 | 
			
		||||
	return *m, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// UnmarshalYAML sets *m to a copy of data.
 | 
			
		||||
func (m *RawMessage) UnmarshalYAML(n *yaml.Node) error {
 | 
			
		||||
	if m == nil {
 | 
			
		||||
		return errors.New("RawMessage UnmarshalYAML on nil pointer")
 | 
			
		||||
	}
 | 
			
		||||
	*m = append((*m)[0:0], []byte(n.Value)...)
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										43
									
								
								codec/context.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										43
									
								
								codec/context.go
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,43 @@
 | 
			
		||||
package codec
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
type codecKey struct{}
 | 
			
		||||
 | 
			
		||||
// FromContext returns codec from context
 | 
			
		||||
func FromContext(ctx context.Context) (Codec, bool) {
 | 
			
		||||
	if ctx == nil {
 | 
			
		||||
		return nil, false
 | 
			
		||||
	}
 | 
			
		||||
	c, ok := ctx.Value(codecKey{}).(Codec)
 | 
			
		||||
	return c, ok
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// MustContext returns codec from context
 | 
			
		||||
func MustContext(ctx context.Context) Codec {
 | 
			
		||||
	c, ok := FromContext(ctx)
 | 
			
		||||
	if !ok {
 | 
			
		||||
		panic("missing codec")
 | 
			
		||||
	}
 | 
			
		||||
	return c
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewContext put codec in context
 | 
			
		||||
func NewContext(ctx context.Context, c Codec) context.Context {
 | 
			
		||||
	if ctx == nil {
 | 
			
		||||
		ctx = context.Background()
 | 
			
		||||
	}
 | 
			
		||||
	return context.WithValue(ctx, codecKey{}, c)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SetOption returns a function to setup a context with given value
 | 
			
		||||
func SetOption(k, v interface{}) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		if o.Context == nil {
 | 
			
		||||
			o.Context = context.Background()
 | 
			
		||||
		}
 | 
			
		||||
		o.Context = context.WithValue(o.Context, k, v)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										35
									
								
								codec/context_test.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										35
									
								
								codec/context_test.go
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,35 @@
 | 
			
		||||
package codec
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"testing"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
func TestFromContext(t *testing.T) {
 | 
			
		||||
	ctx := context.WithValue(context.TODO(), codecKey{}, NewCodec())
 | 
			
		||||
 | 
			
		||||
	c, ok := FromContext(ctx)
 | 
			
		||||
	if c == nil || !ok {
 | 
			
		||||
		t.Fatal("FromContext not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestNewContext(t *testing.T) {
 | 
			
		||||
	ctx := NewContext(context.TODO(), NewCodec())
 | 
			
		||||
 | 
			
		||||
	c, ok := FromContext(ctx)
 | 
			
		||||
	if c == nil || !ok {
 | 
			
		||||
		t.Fatal("NewContext not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestSetOption(t *testing.T) {
 | 
			
		||||
	type key struct{}
 | 
			
		||||
	o := SetOption(key{}, "test")
 | 
			
		||||
	opts := &Options{}
 | 
			
		||||
	o(opts)
 | 
			
		||||
 | 
			
		||||
	if v, ok := opts.Context.Value(key{}).(string); !ok || v == "" {
 | 
			
		||||
		t.Fatal("SetOption not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										58
									
								
								codec/frame.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										58
									
								
								codec/frame.go
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,58 @@
 | 
			
		||||
package codec
 | 
			
		||||
 | 
			
		||||
import "gopkg.in/yaml.v3"
 | 
			
		||||
 | 
			
		||||
// Frame gives us the ability to define raw data to send over the pipes
 | 
			
		||||
type Frame struct {
 | 
			
		||||
	Data []byte
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewFrame returns new frame with data
 | 
			
		||||
func NewFrame(data []byte) *Frame {
 | 
			
		||||
	return &Frame{Data: data}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// MarshalJSON returns frame data
 | 
			
		||||
func (m *Frame) MarshalJSON() ([]byte, error) {
 | 
			
		||||
	return m.Marshal()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// UnmarshalJSON set frame data
 | 
			
		||||
func (m *Frame) UnmarshalJSON(data []byte) error {
 | 
			
		||||
	return m.Unmarshal(data)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// MarshalYAML returns frame data
 | 
			
		||||
func (m *Frame) MarshalYAML() ([]byte, error) {
 | 
			
		||||
	return m.Marshal()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// UnmarshalYAML set frame data
 | 
			
		||||
func (m *Frame) UnmarshalYAML(n *yaml.Node) error {
 | 
			
		||||
	m.Data = []byte(n.Value)
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// ProtoMessage noop func
 | 
			
		||||
func (m *Frame) ProtoMessage() {}
 | 
			
		||||
 | 
			
		||||
// Reset resets frame
 | 
			
		||||
func (m *Frame) Reset() {
 | 
			
		||||
	*m = Frame{}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// String returns frame as string
 | 
			
		||||
func (m *Frame) String() string {
 | 
			
		||||
	return string(m.Data)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Marshal returns frame data
 | 
			
		||||
func (m *Frame) Marshal() ([]byte, error) {
 | 
			
		||||
	return m.Data, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Unmarshal set frame data
 | 
			
		||||
func (m *Frame) Unmarshal(data []byte) error {
 | 
			
		||||
	m.Data = data
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										28
									
								
								codec/frame.proto
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										28
									
								
								codec/frame.proto
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,28 @@
 | 
			
		||||
// Copyright 2021 Unistack LLC
 | 
			
		||||
//
 | 
			
		||||
// Licensed under the Apache License, Version 2.0 (the "License");
 | 
			
		||||
// you may not use this file except in compliance with the License.
 | 
			
		||||
// You may obtain a copy of the License at
 | 
			
		||||
//
 | 
			
		||||
//     http://www.apache.org/licenses/LICENSE-2.0
 | 
			
		||||
//
 | 
			
		||||
// Unless required by applicable law or agreed to in writing, software
 | 
			
		||||
// distributed under the License is distributed on an "AS IS" BASIS,
 | 
			
		||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 | 
			
		||||
// See the License for the specific language governing permissions and
 | 
			
		||||
// limitations under the License.
 | 
			
		||||
 | 
			
		||||
syntax = "proto3";
 | 
			
		||||
 | 
			
		||||
package micro.codec;
 | 
			
		||||
 | 
			
		||||
option cc_enable_arenas = true;
 | 
			
		||||
option go_package = "go.unistack.org/micro/v4/codec;codec";
 | 
			
		||||
option java_multiple_files = true;
 | 
			
		||||
option java_outer_classname = "MicroCodec";
 | 
			
		||||
option java_package = "micro.codec";
 | 
			
		||||
option objc_class_prefix = "MCODEC";
 | 
			
		||||
 | 
			
		||||
message Frame {
 | 
			
		||||
  bytes data = 1;
 | 
			
		||||
}
 | 
			
		||||
@@ -2,72 +2,12 @@ package codec
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"encoding/json"
 | 
			
		||||
	"io"
 | 
			
		||||
 | 
			
		||||
	codecpb "go.unistack.org/micro-proto/v4/codec"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
type noopCodec struct {
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Frame gives us the ability to define raw data to send over the pipes
 | 
			
		||||
type Frame struct {
 | 
			
		||||
	Data []byte
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (c *noopCodec) ReadHeader(conn io.Reader, m *Message, t MessageType) error {
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (c *noopCodec) ReadBody(conn io.Reader, b interface{}) error {
 | 
			
		||||
	// read bytes
 | 
			
		||||
	buf, err := io.ReadAll(conn)
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		return err
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if b == nil {
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	switch v := b.(type) {
 | 
			
		||||
	case *string:
 | 
			
		||||
		*v = string(buf)
 | 
			
		||||
	case *[]byte:
 | 
			
		||||
		*v = buf
 | 
			
		||||
	case *Frame:
 | 
			
		||||
		v.Data = buf
 | 
			
		||||
	default:
 | 
			
		||||
		return json.Unmarshal(buf, v)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (c *noopCodec) Write(conn io.Writer, m *Message, b interface{}) error {
 | 
			
		||||
	if b == nil {
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	var v []byte
 | 
			
		||||
	switch vb := b.(type) {
 | 
			
		||||
	case *Frame:
 | 
			
		||||
		v = vb.Data
 | 
			
		||||
	case string:
 | 
			
		||||
		v = []byte(vb)
 | 
			
		||||
	case *string:
 | 
			
		||||
		v = []byte(*vb)
 | 
			
		||||
	case *[]byte:
 | 
			
		||||
		v = *vb
 | 
			
		||||
	case []byte:
 | 
			
		||||
		v = vb
 | 
			
		||||
	default:
 | 
			
		||||
		var err error
 | 
			
		||||
		v, err = json.Marshal(vb)
 | 
			
		||||
		if err != nil {
 | 
			
		||||
			return err
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
	_, err := conn.Write(v)
 | 
			
		||||
	return err
 | 
			
		||||
	opts Options
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (c *noopCodec) String() string {
 | 
			
		||||
@@ -75,11 +15,11 @@ func (c *noopCodec) String() string {
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewCodec returns new noop codec
 | 
			
		||||
func NewCodec() Codec {
 | 
			
		||||
	return &noopCodec{}
 | 
			
		||||
func NewCodec(opts ...Option) Codec {
 | 
			
		||||
	return &noopCodec{opts: NewOptions(opts...)}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (c *noopCodec) Marshal(v interface{}) ([]byte, error) {
 | 
			
		||||
func (c *noopCodec) Marshal(v interface{}, opts ...Option) ([]byte, error) {
 | 
			
		||||
	if v == nil {
 | 
			
		||||
		return nil, nil
 | 
			
		||||
	}
 | 
			
		||||
@@ -95,14 +35,14 @@ func (c *noopCodec) Marshal(v interface{}) ([]byte, error) {
 | 
			
		||||
		return ve, nil
 | 
			
		||||
	case *Frame:
 | 
			
		||||
		return ve.Data, nil
 | 
			
		||||
	case *Message:
 | 
			
		||||
		return ve.Body, nil
 | 
			
		||||
	case *codecpb.Frame:
 | 
			
		||||
		return ve.Data, nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return json.Marshal(v)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (c *noopCodec) Unmarshal(d []byte, v interface{}) error {
 | 
			
		||||
func (c *noopCodec) Unmarshal(d []byte, v interface{}, opts ...Option) error {
 | 
			
		||||
	if v == nil {
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
@@ -110,14 +50,17 @@ func (c *noopCodec) Unmarshal(d []byte, v interface{}) error {
 | 
			
		||||
	case *string:
 | 
			
		||||
		*ve = string(d)
 | 
			
		||||
		return nil
 | 
			
		||||
	case []byte:
 | 
			
		||||
		copy(ve, d)
 | 
			
		||||
		return nil
 | 
			
		||||
	case *[]byte:
 | 
			
		||||
		*ve = d
 | 
			
		||||
		return nil
 | 
			
		||||
	case *Frame:
 | 
			
		||||
		ve.Data = d
 | 
			
		||||
		return nil
 | 
			
		||||
	case *Message:
 | 
			
		||||
		ve.Body = d
 | 
			
		||||
	case *codecpb.Frame:
 | 
			
		||||
		ve.Data = d
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -5,7 +5,7 @@ import (
 | 
			
		||||
	"testing"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
func TestNoopBytes(t *testing.T) {
 | 
			
		||||
func TestNoopBytesPtr(t *testing.T) {
 | 
			
		||||
	req := []byte("test req")
 | 
			
		||||
	rsp := make([]byte, len(req))
 | 
			
		||||
 | 
			
		||||
@@ -19,6 +19,20 @@ func TestNoopBytes(t *testing.T) {
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestNoopBytes(t *testing.T) {
 | 
			
		||||
	req := []byte("test req")
 | 
			
		||||
	var rsp []byte
 | 
			
		||||
 | 
			
		||||
	nc := NewCodec()
 | 
			
		||||
	if err := nc.Unmarshal(req, &rsp); err != nil {
 | 
			
		||||
		t.Fatal(err)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if !bytes.Equal(req, rsp) {
 | 
			
		||||
		t.Fatalf("req not eq rsp: %s != %s", req, rsp)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestNoopString(t *testing.T) {
 | 
			
		||||
	req := []byte("test req")
 | 
			
		||||
	var rsp string
 | 
			
		||||
 
 | 
			
		||||
@@ -1,9 +1,11 @@
 | 
			
		||||
package codec
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"github.com/unistack-org/micro/v3/logger"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/meter"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/tracer"
 | 
			
		||||
	"context"
 | 
			
		||||
 | 
			
		||||
	"go.unistack.org/micro/v4/logger"
 | 
			
		||||
	"go.unistack.org/micro/v4/meter"
 | 
			
		||||
	"go.unistack.org/micro/v4/tracer"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Option func
 | 
			
		||||
@@ -11,16 +13,31 @@ type Option func(*Options)
 | 
			
		||||
 | 
			
		||||
// Options contains codec options
 | 
			
		||||
type Options struct {
 | 
			
		||||
	MaxMsgSize int
 | 
			
		||||
	Meter      meter.Meter
 | 
			
		||||
	Logger     logger.Logger
 | 
			
		||||
	Tracer     tracer.Tracer
 | 
			
		||||
	// Meter used for metrics
 | 
			
		||||
	Meter meter.Meter
 | 
			
		||||
	// Logger used for logging
 | 
			
		||||
	Logger logger.Logger
 | 
			
		||||
	// Tracer used for tracing
 | 
			
		||||
	Tracer tracer.Tracer
 | 
			
		||||
	// Context stores additional codec options
 | 
			
		||||
	Context context.Context
 | 
			
		||||
	// TagName specifies tag name in struct to control codec
 | 
			
		||||
	TagName string
 | 
			
		||||
	// Flatten specifies that struct must be analyzed for flatten tag
 | 
			
		||||
	Flatten bool
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// MaxMsgSize sets the max message size
 | 
			
		||||
func MaxMsgSize(n int) Option {
 | 
			
		||||
// TagName sets the codec tag name in struct
 | 
			
		||||
func TagName(n string) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.MaxMsgSize = n
 | 
			
		||||
		o.TagName = n
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Flatten enables checking for flatten tag name
 | 
			
		||||
func Flatten(b bool) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.Flatten = b
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
@@ -48,10 +65,12 @@ func Meter(m meter.Meter) Option {
 | 
			
		||||
// NewOptions returns new options
 | 
			
		||||
func NewOptions(opts ...Option) Options {
 | 
			
		||||
	options := Options{
 | 
			
		||||
		Logger:     logger.DefaultLogger,
 | 
			
		||||
		Meter:      meter.DefaultMeter,
 | 
			
		||||
		Tracer:     tracer.DefaultTracer,
 | 
			
		||||
		MaxMsgSize: DefaultMaxMsgSize,
 | 
			
		||||
		Context: context.Background(),
 | 
			
		||||
		Logger:  logger.DefaultLogger,
 | 
			
		||||
		Meter:   meter.DefaultMeter,
 | 
			
		||||
		Tracer:  tracer.DefaultTracer,
 | 
			
		||||
		TagName: DefaultTagName,
 | 
			
		||||
		Flatten: false,
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	for _, o := range opts {
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										195
									
								
								config/config.go
									
									
									
									
									
								
							
							
						
						
									
										195
									
								
								config/config.go
									
									
									
									
									
								
							@@ -4,12 +4,22 @@ package config
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"errors"
 | 
			
		||||
	"reflect"
 | 
			
		||||
	"time"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
var (
 | 
			
		||||
	// DefaultConfig default config
 | 
			
		||||
	DefaultConfig Config = NewConfig()
 | 
			
		||||
)
 | 
			
		||||
type Validator interface {
 | 
			
		||||
	Validate() error
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// DefaultConfig default config
 | 
			
		||||
var DefaultConfig = NewConfig()
 | 
			
		||||
 | 
			
		||||
// DefaultWatcherMinInterval default min interval for poll changes
 | 
			
		||||
var DefaultWatcherMinInterval = 5 * time.Second
 | 
			
		||||
 | 
			
		||||
// DefaultWatcherMaxInterval default max interval for poll changes
 | 
			
		||||
var DefaultWatcherMaxInterval = 9 * time.Second
 | 
			
		||||
 | 
			
		||||
var (
 | 
			
		||||
	// ErrCodecMissing is returned when codec needed and not specified
 | 
			
		||||
@@ -18,40 +28,197 @@ var (
 | 
			
		||||
	ErrInvalidStruct = errors.New("invalid struct specified")
 | 
			
		||||
	// ErrWatcherStopped is returned when source watcher has been stopped
 | 
			
		||||
	ErrWatcherStopped = errors.New("watcher stopped")
 | 
			
		||||
	// ErrWatcherNotImplemented returned when config does not implement watch
 | 
			
		||||
	ErrWatcherNotImplemented = errors.New("watcher not implemented")
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Config is an interface abstraction for dynamic configuration
 | 
			
		||||
type Config interface {
 | 
			
		||||
	// Name returns name of config
 | 
			
		||||
	Name() string
 | 
			
		||||
	// Init the config
 | 
			
		||||
	Init(opts ...Option) error
 | 
			
		||||
	// Options in the config
 | 
			
		||||
	Options() Options
 | 
			
		||||
	// Load config from sources
 | 
			
		||||
	Load(context.Context) error
 | 
			
		||||
	Load(context.Context, ...LoadOption) error
 | 
			
		||||
	// Save config to sources
 | 
			
		||||
	Save(context.Context) error
 | 
			
		||||
	// Watch a value for changes
 | 
			
		||||
	//	Watch(interface{}) (Watcher, error)
 | 
			
		||||
	Save(context.Context, ...SaveOption) error
 | 
			
		||||
	// Watch a config for changes
 | 
			
		||||
	Watch(context.Context, ...WatchOption) (Watcher, error)
 | 
			
		||||
	// String returns config type name
 | 
			
		||||
	String() string
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
type (
 | 
			
		||||
	FuncLoad func(ctx context.Context, opts ...LoadOption) error
 | 
			
		||||
	HookLoad func(next FuncLoad) FuncLoad
 | 
			
		||||
	FuncSave func(ctx context.Context, opts ...SaveOption) error
 | 
			
		||||
	HookSave func(next FuncSave) FuncSave
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Watcher is the config watcher
 | 
			
		||||
//type Watcher interface {
 | 
			
		||||
//	Next() (, error)
 | 
			
		||||
//	Stop() error
 | 
			
		||||
//}
 | 
			
		||||
type Watcher interface {
 | 
			
		||||
	// Next blocks until update happens or error returned
 | 
			
		||||
	Next() (map[string]interface{}, error)
 | 
			
		||||
	// Stop stops watcher
 | 
			
		||||
	Stop() error
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Load loads config from config sources
 | 
			
		||||
func Load(ctx context.Context, cs ...Config) error {
 | 
			
		||||
func Load(ctx context.Context, cs []Config, opts ...LoadOption) error {
 | 
			
		||||
	var err error
 | 
			
		||||
	for _, c := range cs {
 | 
			
		||||
		if err = c.Init(); err != nil {
 | 
			
		||||
			return err
 | 
			
		||||
		}
 | 
			
		||||
		if err = c.Load(ctx); err != nil {
 | 
			
		||||
		if err = c.Load(ctx, opts...); err != nil {
 | 
			
		||||
			return err
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Validate runs Validate() error func for each struct field
 | 
			
		||||
func Validate(ctx context.Context, cfg interface{}) error {
 | 
			
		||||
	if cfg == nil {
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if v, ok := cfg.(Validator); ok {
 | 
			
		||||
		if err := v.Validate(); err != nil {
 | 
			
		||||
			return err
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	sv := reflect.ValueOf(cfg)
 | 
			
		||||
	if sv.Kind() == reflect.Ptr {
 | 
			
		||||
		sv = sv.Elem()
 | 
			
		||||
	}
 | 
			
		||||
	if sv.Kind() != reflect.Struct {
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	typ := sv.Type()
 | 
			
		||||
	for idx := 0; idx < typ.NumField(); idx++ {
 | 
			
		||||
		fld := typ.Field(idx)
 | 
			
		||||
		val := sv.Field(idx)
 | 
			
		||||
		if !val.IsValid() || len(fld.PkgPath) != 0 {
 | 
			
		||||
			continue
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		if v, ok := val.Interface().(Validator); ok {
 | 
			
		||||
			if err := v.Validate(); err != nil {
 | 
			
		||||
				return err
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		switch val.Kind() {
 | 
			
		||||
		case reflect.Ptr:
 | 
			
		||||
			if reflect.Indirect(val).Kind() == reflect.Struct {
 | 
			
		||||
				if err := Validate(ctx, val.Interface()); err != nil {
 | 
			
		||||
					return err
 | 
			
		||||
				}
 | 
			
		||||
			}
 | 
			
		||||
		case reflect.Struct:
 | 
			
		||||
			if err := Validate(ctx, val.Interface()); err != nil {
 | 
			
		||||
				return err
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
var (
 | 
			
		||||
	// DefaultBeforeLoad default func that runs before config Load
 | 
			
		||||
	DefaultBeforeLoad = func(ctx context.Context, c Config) error {
 | 
			
		||||
		for _, fn := range c.Options().BeforeLoad {
 | 
			
		||||
			if fn == nil {
 | 
			
		||||
				return nil
 | 
			
		||||
			}
 | 
			
		||||
			if err := fn(ctx, c); err != nil {
 | 
			
		||||
				c.Options().Logger.Error(ctx, c.String()+" BeforeLoad error", err)
 | 
			
		||||
				if !c.Options().AllowFail {
 | 
			
		||||
					return err
 | 
			
		||||
				}
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
	// DefaultAfterLoad default func that runs after config Load
 | 
			
		||||
	DefaultAfterLoad = func(ctx context.Context, c Config) error {
 | 
			
		||||
		for _, fn := range c.Options().AfterLoad {
 | 
			
		||||
			if fn == nil {
 | 
			
		||||
				return nil
 | 
			
		||||
			}
 | 
			
		||||
			if err := fn(ctx, c); err != nil {
 | 
			
		||||
				c.Options().Logger.Error(ctx, c.String()+" AfterLoad error", err)
 | 
			
		||||
				if !c.Options().AllowFail {
 | 
			
		||||
					return err
 | 
			
		||||
				}
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
	// DefaultBeforeSave default func that runs befora config Save
 | 
			
		||||
	DefaultBeforeSave = func(ctx context.Context, c Config) error {
 | 
			
		||||
		for _, fn := range c.Options().BeforeSave {
 | 
			
		||||
			if fn == nil {
 | 
			
		||||
				return nil
 | 
			
		||||
			}
 | 
			
		||||
			if err := fn(ctx, c); err != nil {
 | 
			
		||||
				c.Options().Logger.Error(ctx, c.String()+" BeforeSave error", err)
 | 
			
		||||
				if !c.Options().AllowFail {
 | 
			
		||||
					return err
 | 
			
		||||
				}
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
	// DefaultAfterSave default func that runs after config Save
 | 
			
		||||
	DefaultAfterSave = func(ctx context.Context, c Config) error {
 | 
			
		||||
		for _, fn := range c.Options().AfterSave {
 | 
			
		||||
			if fn == nil {
 | 
			
		||||
				return nil
 | 
			
		||||
			}
 | 
			
		||||
			if err := fn(ctx, c); err != nil {
 | 
			
		||||
				c.Options().Logger.Error(ctx, c.String()+" AfterSave error", err)
 | 
			
		||||
				if !c.Options().AllowFail {
 | 
			
		||||
					return err
 | 
			
		||||
				}
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
	// DefaultBeforeInit default func that runs befora config Init
 | 
			
		||||
	DefaultBeforeInit = func(ctx context.Context, c Config) error {
 | 
			
		||||
		for _, fn := range c.Options().BeforeInit {
 | 
			
		||||
			if fn == nil {
 | 
			
		||||
				return nil
 | 
			
		||||
			}
 | 
			
		||||
			if err := fn(ctx, c); err != nil {
 | 
			
		||||
				c.Options().Logger.Error(ctx, c.String()+" BeforeInit error", err)
 | 
			
		||||
				if !c.Options().AllowFail {
 | 
			
		||||
					return err
 | 
			
		||||
				}
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
	// DefaultAfterInit default func that runs after config Init
 | 
			
		||||
	DefaultAfterInit = func(ctx context.Context, c Config) error {
 | 
			
		||||
		for _, fn := range c.Options().AfterSave {
 | 
			
		||||
			if fn == nil {
 | 
			
		||||
				return nil
 | 
			
		||||
			}
 | 
			
		||||
			if err := fn(ctx, c); err != nil {
 | 
			
		||||
				c.Options().Logger.Error(ctx, c.String()+" AfterInit error", err)
 | 
			
		||||
				if !c.Options().AllowFail {
 | 
			
		||||
					return err
 | 
			
		||||
				}
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
)
 | 
			
		||||
 
 | 
			
		||||
@@ -15,6 +15,15 @@ func FromContext(ctx context.Context) (Config, bool) {
 | 
			
		||||
	return c, ok
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// MustContext returns store from context
 | 
			
		||||
func MustContext(ctx context.Context) Config {
 | 
			
		||||
	c, ok := FromContext(ctx)
 | 
			
		||||
	if !ok {
 | 
			
		||||
		panic("missing config")
 | 
			
		||||
	}
 | 
			
		||||
	return c
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewContext put store in context
 | 
			
		||||
func NewContext(ctx context.Context, c Config) context.Context {
 | 
			
		||||
	if ctx == nil {
 | 
			
		||||
@@ -32,3 +41,33 @@ func SetOption(k, v interface{}) Option {
 | 
			
		||||
		o.Context = context.WithValue(o.Context, k, v)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SetSaveOption returns a function to setup a context with given value
 | 
			
		||||
func SetSaveOption(k, v interface{}) SaveOption {
 | 
			
		||||
	return func(o *SaveOptions) {
 | 
			
		||||
		if o.Context == nil {
 | 
			
		||||
			o.Context = context.Background()
 | 
			
		||||
		}
 | 
			
		||||
		o.Context = context.WithValue(o.Context, k, v)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SetLoadOption returns a function to setup a context with given value
 | 
			
		||||
func SetLoadOption(k, v interface{}) LoadOption {
 | 
			
		||||
	return func(o *LoadOptions) {
 | 
			
		||||
		if o.Context == nil {
 | 
			
		||||
			o.Context = context.Background()
 | 
			
		||||
		}
 | 
			
		||||
		o.Context = context.WithValue(o.Context, k, v)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SetWatchOption returns a function to setup a context with given value
 | 
			
		||||
func SetWatchOption(k, v interface{}) WatchOption {
 | 
			
		||||
	return func(o *WatchOptions) {
 | 
			
		||||
		if o.Context == nil {
 | 
			
		||||
			o.Context = context.Background()
 | 
			
		||||
		}
 | 
			
		||||
		o.Context = context.WithValue(o.Context, k, v)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										86
									
								
								config/context_test.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										86
									
								
								config/context_test.go
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,86 @@
 | 
			
		||||
package config
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"testing"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
func TestFromNilContext(t *testing.T) {
 | 
			
		||||
	// nolint: staticcheck
 | 
			
		||||
	c, ok := FromContext(nil)
 | 
			
		||||
	if ok || c != nil {
 | 
			
		||||
		t.Fatal("FromContext not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestNewNilContext(t *testing.T) {
 | 
			
		||||
	// nolint: staticcheck
 | 
			
		||||
	ctx := NewContext(nil, NewConfig())
 | 
			
		||||
 | 
			
		||||
	c, ok := FromContext(ctx)
 | 
			
		||||
	if c == nil || !ok {
 | 
			
		||||
		t.Fatal("NewContext not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestFromContext(t *testing.T) {
 | 
			
		||||
	ctx := context.WithValue(context.TODO(), configKey{}, NewConfig())
 | 
			
		||||
 | 
			
		||||
	c, ok := FromContext(ctx)
 | 
			
		||||
	if c == nil || !ok {
 | 
			
		||||
		t.Fatal("FromContext not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestNewContext(t *testing.T) {
 | 
			
		||||
	ctx := NewContext(context.TODO(), NewConfig())
 | 
			
		||||
 | 
			
		||||
	c, ok := FromContext(ctx)
 | 
			
		||||
	if c == nil || !ok {
 | 
			
		||||
		t.Fatal("NewContext not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestSetOption(t *testing.T) {
 | 
			
		||||
	type key struct{}
 | 
			
		||||
	o := SetOption(key{}, "test")
 | 
			
		||||
	opts := &Options{}
 | 
			
		||||
	o(opts)
 | 
			
		||||
 | 
			
		||||
	if v, ok := opts.Context.Value(key{}).(string); !ok || v == "" {
 | 
			
		||||
		t.Fatal("SetOption not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestSetSaveOption(t *testing.T) {
 | 
			
		||||
	type key struct{}
 | 
			
		||||
	o := SetSaveOption(key{}, "test")
 | 
			
		||||
	opts := &SaveOptions{}
 | 
			
		||||
	o(opts)
 | 
			
		||||
 | 
			
		||||
	if v, ok := opts.Context.Value(key{}).(string); !ok || v == "" {
 | 
			
		||||
		t.Fatal("SetSaveOption not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestSetLoadOption(t *testing.T) {
 | 
			
		||||
	type key struct{}
 | 
			
		||||
	o := SetLoadOption(key{}, "test")
 | 
			
		||||
	opts := &LoadOptions{}
 | 
			
		||||
	o(opts)
 | 
			
		||||
 | 
			
		||||
	if v, ok := opts.Context.Value(key{}).(string); !ok || v == "" {
 | 
			
		||||
		t.Fatal("SetLoadOption not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestSetWatchOption(t *testing.T) {
 | 
			
		||||
	type key struct{}
 | 
			
		||||
	o := SetWatchOption(key{}, "test")
 | 
			
		||||
	opts := &WatchOptions{}
 | 
			
		||||
	o(opts)
 | 
			
		||||
 | 
			
		||||
	if v, ok := opts.Context.Value(key{}).(string); !ok || v == "" {
 | 
			
		||||
		t.Fatal("SetWatchOption not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
@@ -5,13 +5,20 @@ import (
 | 
			
		||||
	"reflect"
 | 
			
		||||
	"strconv"
 | 
			
		||||
	"strings"
 | 
			
		||||
	"time"
 | 
			
		||||
 | 
			
		||||
	"github.com/imdario/mergo"
 | 
			
		||||
	rutil "github.com/unistack-org/micro/v3/util/reflect"
 | 
			
		||||
	"dario.cat/mergo"
 | 
			
		||||
	"github.com/google/uuid"
 | 
			
		||||
	"go.unistack.org/micro/v4/options"
 | 
			
		||||
	mid "go.unistack.org/micro/v4/util/id"
 | 
			
		||||
	rutil "go.unistack.org/micro/v4/util/reflect"
 | 
			
		||||
	mtime "go.unistack.org/micro/v4/util/time"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
type defaultConfig struct {
 | 
			
		||||
	opts Options
 | 
			
		||||
	funcLoad FuncLoad
 | 
			
		||||
	funcSave FuncSave
 | 
			
		||||
	opts     Options
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (c *defaultConfig) Options() Options {
 | 
			
		||||
@@ -22,42 +29,90 @@ func (c *defaultConfig) Init(opts ...Option) error {
 | 
			
		||||
	for _, o := range opts {
 | 
			
		||||
		o(&c.opts)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if err := DefaultBeforeInit(c.opts.Context, c); err != nil && !c.opts.AllowFail {
 | 
			
		||||
		return err
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	c.funcLoad = c.fnLoad
 | 
			
		||||
	c.funcSave = c.fnSave
 | 
			
		||||
 | 
			
		||||
	c.opts.Hooks.EachPrev(func(hook options.Hook) {
 | 
			
		||||
		switch h := hook.(type) {
 | 
			
		||||
		case HookLoad:
 | 
			
		||||
			c.funcLoad = h(c.funcLoad)
 | 
			
		||||
		case HookSave:
 | 
			
		||||
			c.funcSave = h(c.funcSave)
 | 
			
		||||
		}
 | 
			
		||||
	})
 | 
			
		||||
 | 
			
		||||
	if err := DefaultAfterInit(c.opts.Context, c); err != nil && !c.opts.AllowFail {
 | 
			
		||||
		return err
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (c *defaultConfig) Load(ctx context.Context) error {
 | 
			
		||||
	for _, fn := range c.opts.BeforeLoad {
 | 
			
		||||
		if err := fn(ctx, c); err != nil && !c.opts.AllowFail {
 | 
			
		||||
func (c *defaultConfig) Load(ctx context.Context, opts ...LoadOption) error {
 | 
			
		||||
	return c.funcLoad(ctx, opts...)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (c *defaultConfig) fnLoad(ctx context.Context, opts ...LoadOption) error {
 | 
			
		||||
	var err error
 | 
			
		||||
 | 
			
		||||
	if c.opts.SkipLoad != nil && c.opts.SkipLoad(ctx, c) {
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if err = DefaultBeforeLoad(ctx, c); err != nil && !c.opts.AllowFail {
 | 
			
		||||
		return err
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	options := NewLoadOptions(opts...)
 | 
			
		||||
	mopts := []func(*mergo.Config){mergo.WithTypeCheck}
 | 
			
		||||
	if options.Override {
 | 
			
		||||
		mopts = append(mopts, mergo.WithOverride)
 | 
			
		||||
	}
 | 
			
		||||
	if options.Append {
 | 
			
		||||
		mopts = append(mopts, mergo.WithAppendSlice)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	dst := c.opts.Struct
 | 
			
		||||
	if options.Struct != nil {
 | 
			
		||||
		dst = options.Struct
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	src, err := rutil.Zero(dst)
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		if !c.opts.AllowFail {
 | 
			
		||||
			return err
 | 
			
		||||
		}
 | 
			
		||||
		if err = DefaultAfterLoad(ctx, c); err != nil && !c.opts.AllowFail {
 | 
			
		||||
			return err
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	src, err := rutil.Zero(c.opts.Struct)
 | 
			
		||||
	if err == nil {
 | 
			
		||||
		valueOf := reflect.ValueOf(src)
 | 
			
		||||
		if err = c.fillValues(ctx, valueOf); err == nil {
 | 
			
		||||
			err = mergo.Merge(c.opts.Struct, src, mergo.WithOverride, mergo.WithTypeCheck, mergo.WithAppendSlice)
 | 
			
		||||
		}
 | 
			
		||||
	if err = fillValues(reflect.ValueOf(src), c.opts.StructTag); err == nil {
 | 
			
		||||
		err = mergo.Merge(dst, src, mopts...)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if err != nil && !c.opts.AllowFail {
 | 
			
		||||
		return err
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	for _, fn := range c.opts.AfterLoad {
 | 
			
		||||
		if err := fn(ctx, c); err != nil && !c.opts.AllowFail {
 | 
			
		||||
			return err
 | 
			
		||||
		}
 | 
			
		||||
	if err := DefaultAfterLoad(ctx, c); err != nil && !c.opts.AllowFail {
 | 
			
		||||
		return err
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
//nolint:gocyclo
 | 
			
		||||
func (c *defaultConfig) fillValue(ctx context.Context, value reflect.Value, val string) error {
 | 
			
		||||
func fillValue(value reflect.Value, val string) error {
 | 
			
		||||
	if !rutil.IsEmpty(value) {
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	switch value.Kind() {
 | 
			
		||||
	case reflect.Map:
 | 
			
		||||
		t := value.Type()
 | 
			
		||||
@@ -71,10 +126,10 @@ func (c *defaultConfig) fillValue(ctx context.Context, value reflect.Value, val
 | 
			
		||||
			kv := strings.FieldsFunc(nval, func(c rune) bool { return c == '=' })
 | 
			
		||||
			mkey := reflect.Indirect(reflect.New(kt))
 | 
			
		||||
			mval := reflect.Indirect(reflect.New(et))
 | 
			
		||||
			if err := c.fillValue(ctx, mkey, kv[0]); err != nil {
 | 
			
		||||
			if err := fillValue(mkey, kv[0]); err != nil {
 | 
			
		||||
				return err
 | 
			
		||||
			}
 | 
			
		||||
			if err := c.fillValue(ctx, mval, kv[1]); err != nil {
 | 
			
		||||
			if err := fillValue(mval, kv[1]); err != nil {
 | 
			
		||||
				return err
 | 
			
		||||
			}
 | 
			
		||||
			value.SetMapIndex(mkey, mval)
 | 
			
		||||
@@ -84,7 +139,7 @@ func (c *defaultConfig) fillValue(ctx context.Context, value reflect.Value, val
 | 
			
		||||
		value.Set(reflect.MakeSlice(reflect.SliceOf(value.Type().Elem()), len(nvals), len(nvals)))
 | 
			
		||||
		for idx, nval := range nvals {
 | 
			
		||||
			nvalue := reflect.Indirect(reflect.New(value.Type().Elem()))
 | 
			
		||||
			if err := c.fillValue(ctx, nvalue, nval); err != nil {
 | 
			
		||||
			if err := fillValue(nvalue, nval); err != nil {
 | 
			
		||||
				return err
 | 
			
		||||
			}
 | 
			
		||||
			value.Index(idx).Set(nvalue)
 | 
			
		||||
@@ -96,6 +151,20 @@ func (c *defaultConfig) fillValue(ctx context.Context, value reflect.Value, val
 | 
			
		||||
		}
 | 
			
		||||
		value.Set(reflect.ValueOf(v))
 | 
			
		||||
	case reflect.String:
 | 
			
		||||
		switch val {
 | 
			
		||||
		case "micro:generate uuid":
 | 
			
		||||
			uid, err := uuid.NewRandom()
 | 
			
		||||
			if err != nil {
 | 
			
		||||
				return err
 | 
			
		||||
			}
 | 
			
		||||
			val = uid.String()
 | 
			
		||||
		case "micro:generate id":
 | 
			
		||||
			uid, err := mid.New()
 | 
			
		||||
			if err != nil {
 | 
			
		||||
				return err
 | 
			
		||||
			}
 | 
			
		||||
			val = uid
 | 
			
		||||
		}
 | 
			
		||||
		value.Set(reflect.ValueOf(val))
 | 
			
		||||
	case reflect.Float32:
 | 
			
		||||
		v, err := strconv.ParseFloat(val, 32)
 | 
			
		||||
@@ -134,11 +203,26 @@ func (c *defaultConfig) fillValue(ctx context.Context, value reflect.Value, val
 | 
			
		||||
		}
 | 
			
		||||
		value.Set(reflect.ValueOf(int32(v)))
 | 
			
		||||
	case reflect.Int64:
 | 
			
		||||
		v, err := strconv.ParseInt(val, 10, 64)
 | 
			
		||||
		if err != nil {
 | 
			
		||||
			return err
 | 
			
		||||
		switch {
 | 
			
		||||
		case value.Type().String() == "time.Duration" && value.Type().PkgPath() == "time":
 | 
			
		||||
			v, err := time.ParseDuration(val)
 | 
			
		||||
			if err != nil {
 | 
			
		||||
				return err
 | 
			
		||||
			}
 | 
			
		||||
			value.Set(reflect.ValueOf(v))
 | 
			
		||||
		case value.Type().String() == "time.Duration" && value.Type().PkgPath() == "go.unistack.org/micro/v4/util/time":
 | 
			
		||||
			v, err := mtime.ParseDuration(val)
 | 
			
		||||
			if err != nil {
 | 
			
		||||
				return err
 | 
			
		||||
			}
 | 
			
		||||
			value.SetInt(int64(v))
 | 
			
		||||
		default:
 | 
			
		||||
			v, err := strconv.ParseInt(val, 10, 64)
 | 
			
		||||
			if err != nil {
 | 
			
		||||
				return err
 | 
			
		||||
			}
 | 
			
		||||
			value.Set(reflect.ValueOf(v))
 | 
			
		||||
		}
 | 
			
		||||
		value.Set(reflect.ValueOf(v))
 | 
			
		||||
	case reflect.Uint:
 | 
			
		||||
		v, err := strconv.ParseUint(val, 10, 0)
 | 
			
		||||
		if err != nil {
 | 
			
		||||
@@ -170,10 +254,11 @@ func (c *defaultConfig) fillValue(ctx context.Context, value reflect.Value, val
 | 
			
		||||
		}
 | 
			
		||||
		value.Set(reflect.ValueOf(v))
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (c *defaultConfig) fillValues(ctx context.Context, valueOf reflect.Value) error {
 | 
			
		||||
func fillValues(valueOf reflect.Value, tname string) error {
 | 
			
		||||
	var values reflect.Value
 | 
			
		||||
 | 
			
		||||
	if valueOf.Kind() == reflect.Ptr {
 | 
			
		||||
@@ -200,7 +285,7 @@ func (c *defaultConfig) fillValues(ctx context.Context, valueOf reflect.Value) e
 | 
			
		||||
		switch value.Kind() {
 | 
			
		||||
		case reflect.Struct:
 | 
			
		||||
			value.Set(reflect.Indirect(reflect.New(value.Type())))
 | 
			
		||||
			if err := c.fillValues(ctx, value); err != nil {
 | 
			
		||||
			if err := fillValues(value, tname); err != nil {
 | 
			
		||||
				return err
 | 
			
		||||
			}
 | 
			
		||||
			continue
 | 
			
		||||
@@ -214,17 +299,17 @@ func (c *defaultConfig) fillValues(ctx context.Context, valueOf reflect.Value) e
 | 
			
		||||
				value.Set(reflect.New(value.Type().Elem()))
 | 
			
		||||
			}
 | 
			
		||||
			value = value.Elem()
 | 
			
		||||
			if err := c.fillValues(ctx, value); err != nil {
 | 
			
		||||
			if err := fillValues(value, tname); err != nil {
 | 
			
		||||
				return err
 | 
			
		||||
			}
 | 
			
		||||
			continue
 | 
			
		||||
		}
 | 
			
		||||
		tag, ok := field.Tag.Lookup(c.opts.StructTag)
 | 
			
		||||
		tag, ok := field.Tag.Lookup(tname)
 | 
			
		||||
		if !ok {
 | 
			
		||||
			continue
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		if err := c.fillValue(ctx, value, tag); err != nil {
 | 
			
		||||
		if err := fillValue(value, tag); err != nil {
 | 
			
		||||
			return err
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
@@ -232,17 +317,21 @@ func (c *defaultConfig) fillValues(ctx context.Context, valueOf reflect.Value) e
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (c *defaultConfig) Save(ctx context.Context) error {
 | 
			
		||||
	for _, fn := range c.opts.BeforeSave {
 | 
			
		||||
		if err := fn(ctx, c); err != nil && !c.opts.AllowFail {
 | 
			
		||||
			return err
 | 
			
		||||
		}
 | 
			
		||||
func (c *defaultConfig) Save(ctx context.Context, opts ...SaveOption) error {
 | 
			
		||||
	return c.funcSave(ctx, opts...)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (c *defaultConfig) fnSave(ctx context.Context, opts ...SaveOption) error {
 | 
			
		||||
	if c.opts.SkipSave != nil && c.opts.SkipSave(ctx, c) {
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	for _, fn := range c.opts.AfterSave {
 | 
			
		||||
		if err := fn(ctx, c); err != nil && !c.opts.AllowFail {
 | 
			
		||||
			return err
 | 
			
		||||
		}
 | 
			
		||||
	if err := DefaultBeforeSave(ctx, c); err != nil {
 | 
			
		||||
		return err
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if err := DefaultAfterSave(ctx, c); err != nil {
 | 
			
		||||
		return err
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return nil
 | 
			
		||||
@@ -256,11 +345,19 @@ func (c *defaultConfig) Name() string {
 | 
			
		||||
	return c.opts.Name
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (c *defaultConfig) Watch(_ context.Context, _ ...WatchOption) (Watcher, error) {
 | 
			
		||||
	return nil, ErrWatcherNotImplemented
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewConfig returns new default config source
 | 
			
		||||
func NewConfig(opts ...Option) Config {
 | 
			
		||||
	options := NewOptions(opts...)
 | 
			
		||||
	if len(options.StructTag) == 0 {
 | 
			
		||||
		options.StructTag = "default"
 | 
			
		||||
	}
 | 
			
		||||
	return &defaultConfig{opts: options}
 | 
			
		||||
	c := &defaultConfig{opts: options}
 | 
			
		||||
	c.funcLoad = c.fnLoad
 | 
			
		||||
	c.funcSave = c.fnSave
 | 
			
		||||
 | 
			
		||||
	return c
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -3,37 +3,92 @@ package config_test
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"fmt"
 | 
			
		||||
	"reflect"
 | 
			
		||||
	"testing"
 | 
			
		||||
	"time"
 | 
			
		||||
 | 
			
		||||
	"github.com/unistack-org/micro/v3/config"
 | 
			
		||||
	"go.unistack.org/micro/v4/config"
 | 
			
		||||
	mtime "go.unistack.org/micro/v4/util/time"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
type Cfg struct {
 | 
			
		||||
type cfg struct {
 | 
			
		||||
	MapValue    map[string]bool `default:"key1=true,key2=false"`
 | 
			
		||||
	StructValue *cfgStructValue
 | 
			
		||||
 | 
			
		||||
	StringValue string `default:"string_value"`
 | 
			
		||||
	IntValue    int    `default:"99"`
 | 
			
		||||
	IgnoreValue string `json:"-"`
 | 
			
		||||
	StructValue struct {
 | 
			
		||||
		StringValue string `default:"string_value"`
 | 
			
		||||
	UUIDValue   string `default:"micro:generate uuid"`
 | 
			
		||||
	IDValue     string `default:"micro:generate id"`
 | 
			
		||||
 | 
			
		||||
	DurationValue  time.Duration  `default:"10s"`
 | 
			
		||||
	MDurationValue mtime.Duration `default:"10s"`
 | 
			
		||||
	IntValue       int            `default:"99"`
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
type cfgStructValue struct {
 | 
			
		||||
	StringValue string `default:"string_value"`
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (c *cfg) Validate() error {
 | 
			
		||||
	if c.IntValue != 10 {
 | 
			
		||||
		return fmt.Errorf("invalid IntValue %d != %d", 10, c.IntValue)
 | 
			
		||||
	}
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (c *cfgStructValue) Validate() error {
 | 
			
		||||
	if c.StringValue != "string_value" {
 | 
			
		||||
		return fmt.Errorf("invalid StringValue %s != %s", "string_value", c.StringValue)
 | 
			
		||||
	}
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
type testHook struct {
 | 
			
		||||
	f bool
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (t *testHook) Load(fn config.FuncLoad) config.FuncLoad {
 | 
			
		||||
	return func(ctx context.Context, opts ...config.LoadOption) error {
 | 
			
		||||
		t.f = true
 | 
			
		||||
		return fn(ctx, opts...)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestHook(t *testing.T) {
 | 
			
		||||
	h := &testHook{}
 | 
			
		||||
 | 
			
		||||
	c := config.NewConfig(config.Struct(h), config.Hooks(config.HookLoad(h.Load)))
 | 
			
		||||
 | 
			
		||||
	if err := c.Init(); err != nil {
 | 
			
		||||
		t.Fatal(err)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if err := c.Load(context.TODO()); err != nil {
 | 
			
		||||
		t.Fatal(err)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if !h.f {
 | 
			
		||||
		t.Fatal("hook not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestDefault(t *testing.T) {
 | 
			
		||||
	ctx := context.Background()
 | 
			
		||||
	conf := &Cfg{IntValue: 10}
 | 
			
		||||
	blfn := func(ctx context.Context, cfg config.Config) error {
 | 
			
		||||
		conf, ok := cfg.Options().Struct.(*Cfg)
 | 
			
		||||
	conf := &cfg{IntValue: 10}
 | 
			
		||||
	blfn := func(_ context.Context, c config.Config) error {
 | 
			
		||||
		nconf, ok := c.Options().Struct.(*cfg)
 | 
			
		||||
		if !ok {
 | 
			
		||||
			return fmt.Errorf("failed to get Struct from options: %v", cfg.Options())
 | 
			
		||||
			return fmt.Errorf("failed to get Struct from options: %v", c.Options())
 | 
			
		||||
		}
 | 
			
		||||
		conf.StringValue = "before_load"
 | 
			
		||||
		nconf.StringValue = "before_load"
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
	alfn := func(ctx context.Context, cfg config.Config) error {
 | 
			
		||||
		conf, ok := cfg.Options().Struct.(*Cfg)
 | 
			
		||||
	alfn := func(_ context.Context, c config.Config) error {
 | 
			
		||||
		nconf, ok := c.Options().Struct.(*cfg)
 | 
			
		||||
		if !ok {
 | 
			
		||||
			return fmt.Errorf("failed to get Struct from options: %v", cfg.Options())
 | 
			
		||||
			return fmt.Errorf("failed to get Struct from options: %v", c.Options())
 | 
			
		||||
		}
 | 
			
		||||
		conf.StringValue = "after_load"
 | 
			
		||||
		nconf.StringValue = "after_load"
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
@@ -47,6 +102,45 @@ func TestDefault(t *testing.T) {
 | 
			
		||||
	if conf.StringValue != "after_load" {
 | 
			
		||||
		t.Fatal("AfterLoad option not working")
 | 
			
		||||
	}
 | 
			
		||||
	if len(conf.MapValue) != 2 {
 | 
			
		||||
		t.Fatalf("map value invalid: %#+v\n", conf.MapValue)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	t.Logf("%#+v\n", conf)
 | 
			
		||||
	if conf.UUIDValue == "" {
 | 
			
		||||
		t.Fatalf("uuid value empty")
 | 
			
		||||
	} else if len(conf.UUIDValue) != 36 {
 | 
			
		||||
		t.Fatalf("uuid value invalid: %s", conf.UUIDValue)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if conf.IDValue == "" {
 | 
			
		||||
		t.Fatalf("id value empty")
 | 
			
		||||
	}
 | 
			
		||||
	_ = conf
 | 
			
		||||
	// t.Logf("%#+v\n", conf)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestValidate(t *testing.T) {
 | 
			
		||||
	ctx := context.Background()
 | 
			
		||||
	conf := &cfg{IntValue: 10}
 | 
			
		||||
	cfg := config.NewConfig(config.Struct(conf))
 | 
			
		||||
	if err := cfg.Init(); err != nil {
 | 
			
		||||
		t.Fatal(err)
 | 
			
		||||
	}
 | 
			
		||||
	if err := cfg.Load(ctx); err != nil {
 | 
			
		||||
		t.Fatal(err)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if err := config.Validate(ctx, conf); err != nil {
 | 
			
		||||
		t.Fatal(err)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func Test_SizeOf(t *testing.T) {
 | 
			
		||||
	st := cfg{}
 | 
			
		||||
 | 
			
		||||
	tVal := reflect.TypeOf(st)
 | 
			
		||||
	for i := 0; i < tVal.NumField(); i++ {
 | 
			
		||||
		field := tVal.Field(i)
 | 
			
		||||
		fmt.Printf("Field: %s, Offset: %d, Size: %d\n", field.Name, field.Offset, field.Type.Size())
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -2,35 +2,55 @@ package config
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"time"
 | 
			
		||||
 | 
			
		||||
	"github.com/unistack-org/micro/v3/codec"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/logger"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/meter"
 | 
			
		||||
	"github.com/unistack-org/micro/v3/tracer"
 | 
			
		||||
	"go.unistack.org/micro/v4/codec"
 | 
			
		||||
	"go.unistack.org/micro/v4/logger"
 | 
			
		||||
	"go.unistack.org/micro/v4/meter"
 | 
			
		||||
	"go.unistack.org/micro/v4/options"
 | 
			
		||||
	"go.unistack.org/micro/v4/tracer"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Options hold the config options
 | 
			
		||||
type Options struct {
 | 
			
		||||
	Name       string
 | 
			
		||||
	AllowFail  bool
 | 
			
		||||
	BeforeLoad []func(context.Context, Config) error
 | 
			
		||||
	AfterLoad  []func(context.Context, Config) error
 | 
			
		||||
	BeforeSave []func(context.Context, Config) error
 | 
			
		||||
	AfterSave  []func(context.Context, Config) error
 | 
			
		||||
	// Struct that holds config data
 | 
			
		||||
	// Struct holds the destination config struct
 | 
			
		||||
	Struct interface{}
 | 
			
		||||
	// StructTag name
 | 
			
		||||
	StructTag string
 | 
			
		||||
	// Logger that will be used
 | 
			
		||||
	Logger logger.Logger
 | 
			
		||||
	// Meter that will be used
 | 
			
		||||
	Meter meter.Meter
 | 
			
		||||
	// Tracer used for trace
 | 
			
		||||
	Tracer tracer.Tracer
 | 
			
		||||
	// Codec that used for load/save
 | 
			
		||||
	Codec codec.Codec
 | 
			
		||||
	// Context for alternative data
 | 
			
		||||
	// Tracer that will be used
 | 
			
		||||
	Tracer tracer.Tracer
 | 
			
		||||
	// Meter that will be used
 | 
			
		||||
	Meter meter.Meter
 | 
			
		||||
	// Logger that will be used
 | 
			
		||||
	Logger logger.Logger
 | 
			
		||||
	// Context used for external options
 | 
			
		||||
	Context context.Context
 | 
			
		||||
	// Name of the config
 | 
			
		||||
	Name string
 | 
			
		||||
	// StructTag name
 | 
			
		||||
	StructTag string
 | 
			
		||||
	// BeforeSave contains slice of funcs that runs before Save
 | 
			
		||||
	BeforeSave []func(context.Context, Config) error
 | 
			
		||||
	// AfterSave contains slice of funcs that runs after Save
 | 
			
		||||
	AfterSave []func(context.Context, Config) error
 | 
			
		||||
	// BeforeLoad contains slice of funcs that runs before Load
 | 
			
		||||
	BeforeLoad []func(context.Context, Config) error
 | 
			
		||||
	// AfterLoad contains slice of funcs that runs after Load
 | 
			
		||||
	AfterLoad []func(context.Context, Config) error
 | 
			
		||||
	// BeforeInit contains slice of funcs that runs before Init
 | 
			
		||||
	BeforeInit []func(context.Context, Config) error
 | 
			
		||||
	// AfterInit contains slice of funcs that runs after Init
 | 
			
		||||
	AfterInit []func(context.Context, Config) error
 | 
			
		||||
 | 
			
		||||
	// SkipLoad runs only if condition returns true
 | 
			
		||||
	SkipLoad func(context.Context, Config) bool
 | 
			
		||||
	// SkipSave runs only if condition returns true
 | 
			
		||||
	SkipSave func(context.Context, Config) bool
 | 
			
		||||
	// Hooks can be run before/after config Save/Load
 | 
			
		||||
	Hooks options.Hooks
 | 
			
		||||
 | 
			
		||||
	// AllowFail flag to allow fail in config source
 | 
			
		||||
	AllowFail bool
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Option function signature
 | 
			
		||||
@@ -51,6 +71,72 @@ func NewOptions(opts ...Option) Options {
 | 
			
		||||
	return options
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// LoadOption function signature
 | 
			
		||||
type LoadOption func(o *LoadOptions)
 | 
			
		||||
 | 
			
		||||
// LoadOptions struct
 | 
			
		||||
type LoadOptions struct {
 | 
			
		||||
	Struct   interface{}
 | 
			
		||||
	Context  context.Context
 | 
			
		||||
	Override bool
 | 
			
		||||
	Append   bool
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewLoadOptions create LoadOptions struct with provided opts
 | 
			
		||||
func NewLoadOptions(opts ...LoadOption) LoadOptions {
 | 
			
		||||
	options := LoadOptions{}
 | 
			
		||||
	for _, o := range opts {
 | 
			
		||||
		o(&options)
 | 
			
		||||
	}
 | 
			
		||||
	return options
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// LoadOverride override values when load
 | 
			
		||||
func LoadOverride(b bool) LoadOption {
 | 
			
		||||
	return func(o *LoadOptions) {
 | 
			
		||||
		o.Override = b
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// LoadAppend override values when load
 | 
			
		||||
func LoadAppend(b bool) LoadOption {
 | 
			
		||||
	return func(o *LoadOptions) {
 | 
			
		||||
		o.Append = b
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// LoadStruct override struct for loading
 | 
			
		||||
func LoadStruct(src interface{}) LoadOption {
 | 
			
		||||
	return func(o *LoadOptions) {
 | 
			
		||||
		o.Struct = src
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SaveOption function signature
 | 
			
		||||
type SaveOption func(o *SaveOptions)
 | 
			
		||||
 | 
			
		||||
// SaveOptions struct
 | 
			
		||||
type SaveOptions struct {
 | 
			
		||||
	Struct  interface{}
 | 
			
		||||
	Context context.Context
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SaveStruct override struct for save to config
 | 
			
		||||
func SaveStruct(src interface{}) SaveOption {
 | 
			
		||||
	return func(o *SaveOptions) {
 | 
			
		||||
		o.Struct = src
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewSaveOptions fill SaveOptions struct
 | 
			
		||||
func NewSaveOptions(opts ...SaveOption) SaveOptions {
 | 
			
		||||
	options := SaveOptions{}
 | 
			
		||||
	for _, o := range opts {
 | 
			
		||||
		o(&options)
 | 
			
		||||
	}
 | 
			
		||||
	return options
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// AllowFail allows config source to fail
 | 
			
		||||
func AllowFail(b bool) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
@@ -58,6 +144,20 @@ func AllowFail(b bool) Option {
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// BeforeInit run funcs before config Init
 | 
			
		||||
func BeforeInit(fn ...func(context.Context, Config) error) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.BeforeInit = fn
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// AfterInit run funcs after config Init
 | 
			
		||||
func AfterInit(fn ...func(context.Context, Config) error) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.AfterInit = fn
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// BeforeLoad run funcs before config load
 | 
			
		||||
func BeforeLoad(fn ...func(context.Context, Config) error) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
@@ -134,3 +234,69 @@ func Name(n string) Option {
 | 
			
		||||
		o.Name = n
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WatchOptions struuct
 | 
			
		||||
type WatchOptions struct {
 | 
			
		||||
	// Context used by non default options
 | 
			
		||||
	Context context.Context
 | 
			
		||||
	// Struct for filling
 | 
			
		||||
	Struct interface{}
 | 
			
		||||
	// MinInterval specifies the min time.Duration interval for poll changes
 | 
			
		||||
	MinInterval time.Duration
 | 
			
		||||
	// MaxInterval specifies the max time.Duration interval for poll changes
 | 
			
		||||
	MaxInterval time.Duration
 | 
			
		||||
	// Coalesce multiple events to one
 | 
			
		||||
	Coalesce bool
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WatchOption func signature
 | 
			
		||||
type WatchOption func(*WatchOptions)
 | 
			
		||||
 | 
			
		||||
// NewWatchOptions create WatchOptions struct with provided opts
 | 
			
		||||
func NewWatchOptions(opts ...WatchOption) WatchOptions {
 | 
			
		||||
	options := WatchOptions{
 | 
			
		||||
		Context:     context.Background(),
 | 
			
		||||
		MinInterval: DefaultWatcherMinInterval,
 | 
			
		||||
		MaxInterval: DefaultWatcherMaxInterval,
 | 
			
		||||
	}
 | 
			
		||||
	for _, o := range opts {
 | 
			
		||||
		o(&options)
 | 
			
		||||
	}
 | 
			
		||||
	return options
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WatchContext pass context
 | 
			
		||||
func WatchContext(ctx context.Context) WatchOption {
 | 
			
		||||
	return func(o *WatchOptions) {
 | 
			
		||||
		o.Context = ctx
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WatchCoalesce controls watch event combining
 | 
			
		||||
func WatchCoalesce(b bool) WatchOption {
 | 
			
		||||
	return func(o *WatchOptions) {
 | 
			
		||||
		o.Coalesce = b
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WatchInterval specifies min and max time.Duration for pulling changes
 | 
			
		||||
func WatchInterval(minTime, maxTime time.Duration) WatchOption {
 | 
			
		||||
	return func(o *WatchOptions) {
 | 
			
		||||
		o.MinInterval = minTime
 | 
			
		||||
		o.MaxInterval = maxTime
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// WatchStruct overrides struct for fill
 | 
			
		||||
func WatchStruct(src interface{}) WatchOption {
 | 
			
		||||
	return func(o *WatchOptions) {
 | 
			
		||||
		o.Struct = src
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Hooks sets hook runs before action
 | 
			
		||||
func Hooks(h ...options.Hook) Option {
 | 
			
		||||
	return func(o *Options) {
 | 
			
		||||
		o.Hooks = append(o.Hooks, h...)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -1,26 +0,0 @@
 | 
			
		||||
package config_test
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"testing"
 | 
			
		||||
 | 
			
		||||
	rutil "github.com/unistack-org/micro/v3/util/reflect"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
type Config struct {
 | 
			
		||||
	Value     string
 | 
			
		||||
	SubConfig *SubConfig
 | 
			
		||||
	Config    *Config
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
type SubConfig struct {
 | 
			
		||||
	Value string
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestReflect(t *testing.T) {
 | 
			
		||||
	cfg1 := &Config{Value: "cfg1", Config: &Config{Value: "cfg1_1"}, SubConfig: &SubConfig{Value: "cfg1"}}
 | 
			
		||||
	cfg2, err := rutil.Zero(cfg1)
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		t.Fatal(err)
 | 
			
		||||
	}
 | 
			
		||||
	t.Logf("dst: %#+v\n", cfg2)
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										24
									
								
								context_test.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										24
									
								
								context_test.go
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,24 @@
 | 
			
		||||
package micro
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"testing"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
func TestFromContext(t *testing.T) {
 | 
			
		||||
	ctx := context.WithValue(context.TODO(), serviceKey{}, NewService())
 | 
			
		||||
 | 
			
		||||
	c, ok := FromContext(ctx)
 | 
			
		||||
	if c == nil || !ok {
 | 
			
		||||
		t.Fatal("FromContext not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestNewContext(t *testing.T) {
 | 
			
		||||
	ctx := NewContext(context.TODO(), NewService())
 | 
			
		||||
 | 
			
		||||
	c, ok := FromContext(ctx)
 | 
			
		||||
	if c == nil || !ok {
 | 
			
		||||
		t.Fatal("NewContext not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										157
									
								
								database/dsn.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										157
									
								
								database/dsn.go
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,157 @@
 | 
			
		||||
package database
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"crypto/tls"
 | 
			
		||||
	"errors"
 | 
			
		||||
	"fmt"
 | 
			
		||||
	"net/url"
 | 
			
		||||
	"strings"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
var (
 | 
			
		||||
	ErrInvalidDSNAddr      = errors.New("invalid dsn addr")
 | 
			
		||||
	ErrInvalidDSNUnescaped = errors.New("dsn must be escaped")
 | 
			
		||||
	ErrInvalidDSNNoSlash   = errors.New("dsn must contains slash")
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
type Config struct {
 | 
			
		||||
	TLSConfig *tls.Config
 | 
			
		||||
	Username  string
 | 
			
		||||
	Password  string
 | 
			
		||||
	Scheme    string
 | 
			
		||||
	Host      string
 | 
			
		||||
	Port      string
 | 
			
		||||
	Database  string
 | 
			
		||||
	Params    []string
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (cfg *Config) FormatDSN() string {
 | 
			
		||||
	var s strings.Builder
 | 
			
		||||
 | 
			
		||||
	if len(cfg.Scheme) > 0 {
 | 
			
		||||
		s.WriteString(cfg.Scheme + "://")
 | 
			
		||||
	}
 | 
			
		||||
	// [username[:password]@]
 | 
			
		||||
	if len(cfg.Username) > 0 {
 | 
			
		||||
		s.WriteString(cfg.Username)
 | 
			
		||||
		if len(cfg.Password) > 0 {
 | 
			
		||||
			s.WriteByte(':')
 | 
			
		||||
			s.WriteString(url.PathEscape(cfg.Password))
 | 
			
		||||
		}
 | 
			
		||||
		s.WriteByte('@')
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// [host:port]
 | 
			
		||||
	if len(cfg.Host) > 0 {
 | 
			
		||||
		s.WriteString(cfg.Host)
 | 
			
		||||
		if len(cfg.Port) > 0 {
 | 
			
		||||
			s.WriteByte(':')
 | 
			
		||||
			s.WriteString(cfg.Port)
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// /dbname
 | 
			
		||||
	s.WriteByte('/')
 | 
			
		||||
	s.WriteString(url.PathEscape(cfg.Database))
 | 
			
		||||
 | 
			
		||||
	for i := 0; i < len(cfg.Params); i += 2 {
 | 
			
		||||
		if i == 0 {
 | 
			
		||||
			s.WriteString("?")
 | 
			
		||||
		} else {
 | 
			
		||||
			s.WriteString("&")
 | 
			
		||||
		}
 | 
			
		||||
		s.WriteString(cfg.Params[i])
 | 
			
		||||
		s.WriteString("=")
 | 
			
		||||
		s.WriteString(cfg.Params[i+1])
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return s.String()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func ParseDSN(dsn string) (*Config, error) {
 | 
			
		||||
	cfg := &Config{}
 | 
			
		||||
 | 
			
		||||
	// [user[:password]@][net[(addr)]]/dbname[?param1=value1¶mN=valueN]
 | 
			
		||||
	// Find last '/' that goes before dbname
 | 
			
		||||
	foundSlash := false
 | 
			
		||||
	for i := len(dsn) - 1; i >= 0; i-- {
 | 
			
		||||
		if dsn[i] == '/' {
 | 
			
		||||
			foundSlash = true
 | 
			
		||||
			var j, k int
 | 
			
		||||
 | 
			
		||||
			// left part is empty if i <= 0
 | 
			
		||||
			if i > 0 {
 | 
			
		||||
				// Find the first ':' in dsn
 | 
			
		||||
				for j = i; j >= 0; j-- {
 | 
			
		||||
					if dsn[j] == ':' {
 | 
			
		||||
						cfg.Scheme = dsn[0:j]
 | 
			
		||||
					}
 | 
			
		||||
				}
 | 
			
		||||
 | 
			
		||||
				// [username[:password]@][host]
 | 
			
		||||
				// Find the last '@' in dsn[:i]
 | 
			
		||||
				for j = i; j >= 0; j-- {
 | 
			
		||||
					if dsn[j] == '@' {
 | 
			
		||||
						// username[:password]
 | 
			
		||||
						// Find the second ':' in dsn[:j]
 | 
			
		||||
						for k = 0; k < j; k++ {
 | 
			
		||||
							if dsn[k] == ':' {
 | 
			
		||||
								if cfg.Scheme == dsn[:k] {
 | 
			
		||||
									continue
 | 
			
		||||
								}
 | 
			
		||||
								var err error
 | 
			
		||||
								cfg.Password, err = url.PathUnescape(dsn[k+1 : j])
 | 
			
		||||
								if err != nil {
 | 
			
		||||
									return nil, err
 | 
			
		||||
								}
 | 
			
		||||
								break
 | 
			
		||||
							}
 | 
			
		||||
						}
 | 
			
		||||
						cfg.Username = dsn[len(cfg.Scheme)+3 : k]
 | 
			
		||||
						break
 | 
			
		||||
					}
 | 
			
		||||
				}
 | 
			
		||||
 | 
			
		||||
				for k = j + 1; k < i; k++ {
 | 
			
		||||
					if dsn[k] == ':' {
 | 
			
		||||
						cfg.Host = dsn[j+1 : k]
 | 
			
		||||
						cfg.Port = dsn[k+1 : i]
 | 
			
		||||
						break
 | 
			
		||||
					}
 | 
			
		||||
				}
 | 
			
		||||
 | 
			
		||||
			}
 | 
			
		||||
 | 
			
		||||
			// dbname[?param1=value1&...¶mN=valueN]
 | 
			
		||||
			// Find the first '?' in dsn[i+1:]
 | 
			
		||||
			for j = i + 1; j < len(dsn); j++ {
 | 
			
		||||
				if dsn[j] == '?' {
 | 
			
		||||
					parts := strings.Split(dsn[j+1:], "&")
 | 
			
		||||
					cfg.Params = make([]string, 0, len(parts)*2)
 | 
			
		||||
					for _, p := range parts {
 | 
			
		||||
						k, v, found := strings.Cut(p, "=")
 | 
			
		||||
						if !found {
 | 
			
		||||
							continue
 | 
			
		||||
						}
 | 
			
		||||
						cfg.Params = append(cfg.Params, k, v)
 | 
			
		||||
					}
 | 
			
		||||
 | 
			
		||||
					break
 | 
			
		||||
				}
 | 
			
		||||
			}
 | 
			
		||||
			var err error
 | 
			
		||||
			dbname := dsn[i+1 : j]
 | 
			
		||||
			if cfg.Database, err = url.PathUnescape(dbname); err != nil {
 | 
			
		||||
				return nil, fmt.Errorf("invalid dbname %q: %w", dbname, err)
 | 
			
		||||
			}
 | 
			
		||||
 | 
			
		||||
			break
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if !foundSlash && len(dsn) > 0 {
 | 
			
		||||
		return nil, ErrInvalidDSNNoSlash
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return cfg, nil
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										31
									
								
								database/dsn_test.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										31
									
								
								database/dsn_test.go
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,31 @@
 | 
			
		||||
package database
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"net/url"
 | 
			
		||||
	"testing"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
func TestParseDSN(t *testing.T) {
 | 
			
		||||
	cfg, err := ParseDSN("postgres://username:p@ssword#@host:12345/dbname?key1=val2&key2=val2")
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		t.Fatal(err)
 | 
			
		||||
	}
 | 
			
		||||
	if cfg.Password != "p@ssword#" {
 | 
			
		||||
		t.Fatalf("parsing error")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestFormatDSN(t *testing.T) {
 | 
			
		||||
	src := "postgres://username:p@ssword#@host:12345/dbname?key1=val2&key2=val2"
 | 
			
		||||
	cfg, err := ParseDSN(src)
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		t.Fatal(err)
 | 
			
		||||
	}
 | 
			
		||||
	dst, err := url.PathUnescape(cfg.FormatDSN())
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		t.Fatal(err)
 | 
			
		||||
	}
 | 
			
		||||
	if src != dst {
 | 
			
		||||
		t.Fatalf("\n%s\n%s", src, dst)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										364
									
								
								errors/errors.go
									
									
									
									
									
								
							
							
						
						
									
										364
									
								
								errors/errors.go
									
									
									
									
									
								
							@@ -3,9 +3,18 @@
 | 
			
		||||
package errors
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"bytes"
 | 
			
		||||
	"context"
 | 
			
		||||
	"encoding/json"
 | 
			
		||||
	"errors"
 | 
			
		||||
	"fmt"
 | 
			
		||||
	"io"
 | 
			
		||||
	"net/http"
 | 
			
		||||
	"strconv"
 | 
			
		||||
	"strings"
 | 
			
		||||
 | 
			
		||||
	"google.golang.org/grpc/codes"
 | 
			
		||||
	"google.golang.org/grpc/status"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
var (
 | 
			
		||||
@@ -35,12 +44,30 @@ var (
 | 
			
		||||
	ErrGatewayTimeout = &Error{Code: 504}
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
const ProblemContentType = "application/problem+json"
 | 
			
		||||
 | 
			
		||||
type Problem struct {
 | 
			
		||||
	Type     string `json:"type,omitempty"`
 | 
			
		||||
	Title    string `json:"title,omitempty"`
 | 
			
		||||
	Detail   string `json:"detail,omitempty"`
 | 
			
		||||
	Instance string `json:"instance,omitempty"`
 | 
			
		||||
	Errors   []struct {
 | 
			
		||||
		Title  string `json:"title,omitempty"`
 | 
			
		||||
		Detail string `json:"detail,omitempty"`
 | 
			
		||||
	} `json:"errors,omitempty"`
 | 
			
		||||
	Status int `json:"status,omitempty"`
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Error type
 | 
			
		||||
type Error struct {
 | 
			
		||||
	Id     string
 | 
			
		||||
	Code   int32
 | 
			
		||||
	// ID holds error id or service, usually someting like my_service or id
 | 
			
		||||
	ID string
 | 
			
		||||
	// Detail holds some useful details about error
 | 
			
		||||
	Detail string
 | 
			
		||||
	// Status usually holds text of http status
 | 
			
		||||
	Status string
 | 
			
		||||
	// Code holds error code
 | 
			
		||||
	Code int32
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Error satisfies error interface
 | 
			
		||||
@@ -49,10 +76,26 @@ func (e *Error) Error() string {
 | 
			
		||||
	return string(b)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// New generates a custom error.
 | 
			
		||||
/*
 | 
			
		||||
// Generator struct holds id of error
 | 
			
		||||
type Generator struct {
 | 
			
		||||
	id string
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Generator can emit new error with static id
 | 
			
		||||
func NewGenerator(id string) *Generator {
 | 
			
		||||
	return &Generator{id: id}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (g *Generator) BadRequest(format string, args ...interface{}) error {
 | 
			
		||||
	return BadRequest(g.id, format, args...)
 | 
			
		||||
}
 | 
			
		||||
*/
 | 
			
		||||
 | 
			
		||||
// New generates a custom error
 | 
			
		||||
func New(id, detail string, code int32) error {
 | 
			
		||||
	return &Error{
 | 
			
		||||
		Id:     id,
 | 
			
		||||
		ID:     id,
 | 
			
		||||
		Code:   code,
 | 
			
		||||
		Detail: detail,
 | 
			
		||||
		Status: http.StatusText(int(code)),
 | 
			
		||||
@@ -62,130 +105,130 @@ func New(id, detail string, code int32) error {
 | 
			
		||||
// Parse tries to parse a JSON string into an error. If that
 | 
			
		||||
// fails, it will set the given string as the error detail.
 | 
			
		||||
func Parse(err string) *Error {
 | 
			
		||||
	e := new(Error)
 | 
			
		||||
	errr := json.Unmarshal([]byte(err), e)
 | 
			
		||||
	if errr != nil {
 | 
			
		||||
	e := &Error{}
 | 
			
		||||
	nerr := json.Unmarshal([]byte(err), e)
 | 
			
		||||
	if nerr != nil {
 | 
			
		||||
		e.Detail = err
 | 
			
		||||
	}
 | 
			
		||||
	return e
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// BadRequest generates a 400 error.
 | 
			
		||||
func BadRequest(id, format string, a ...interface{}) error {
 | 
			
		||||
func BadRequest(id, format string, args ...interface{}) error {
 | 
			
		||||
	return &Error{
 | 
			
		||||
		Id:     id,
 | 
			
		||||
		ID:     id,
 | 
			
		||||
		Code:   400,
 | 
			
		||||
		Detail: fmt.Sprintf(format, a...),
 | 
			
		||||
		Detail: fmt.Sprintf(format, args...),
 | 
			
		||||
		Status: http.StatusText(400),
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Unauthorized generates a 401 error.
 | 
			
		||||
func Unauthorized(id, format string, a ...interface{}) error {
 | 
			
		||||
func Unauthorized(id, format string, args ...interface{}) error {
 | 
			
		||||
	return &Error{
 | 
			
		||||
		Id:     id,
 | 
			
		||||
		ID:     id,
 | 
			
		||||
		Code:   401,
 | 
			
		||||
		Detail: fmt.Sprintf(format, a...),
 | 
			
		||||
		Detail: fmt.Sprintf(format, args...),
 | 
			
		||||
		Status: http.StatusText(401),
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Forbidden generates a 403 error.
 | 
			
		||||
func Forbidden(id, format string, a ...interface{}) error {
 | 
			
		||||
func Forbidden(id, format string, args ...interface{}) error {
 | 
			
		||||
	return &Error{
 | 
			
		||||
		Id:     id,
 | 
			
		||||
		ID:     id,
 | 
			
		||||
		Code:   403,
 | 
			
		||||
		Detail: fmt.Sprintf(format, a...),
 | 
			
		||||
		Detail: fmt.Sprintf(format, args...),
 | 
			
		||||
		Status: http.StatusText(403),
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NotFound generates a 404 error.
 | 
			
		||||
func NotFound(id, format string, a ...interface{}) error {
 | 
			
		||||
func NotFound(id, format string, args ...interface{}) error {
 | 
			
		||||
	return &Error{
 | 
			
		||||
		Id:     id,
 | 
			
		||||
		ID:     id,
 | 
			
		||||
		Code:   404,
 | 
			
		||||
		Detail: fmt.Sprintf(format, a...),
 | 
			
		||||
		Detail: fmt.Sprintf(format, args...),
 | 
			
		||||
		Status: http.StatusText(404),
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// MethodNotAllowed generates a 405 error.
 | 
			
		||||
func MethodNotAllowed(id, format string, a ...interface{}) error {
 | 
			
		||||
func MethodNotAllowed(id, format string, args ...interface{}) error {
 | 
			
		||||
	return &Error{
 | 
			
		||||
		Id:     id,
 | 
			
		||||
		ID:     id,
 | 
			
		||||
		Code:   405,
 | 
			
		||||
		Detail: fmt.Sprintf(format, a...),
 | 
			
		||||
		Detail: fmt.Sprintf(format, args...),
 | 
			
		||||
		Status: http.StatusText(405),
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Timeout generates a 408 error.
 | 
			
		||||
func Timeout(id, format string, a ...interface{}) error {
 | 
			
		||||
func Timeout(id, format string, args ...interface{}) error {
 | 
			
		||||
	return &Error{
 | 
			
		||||
		Id:     id,
 | 
			
		||||
		ID:     id,
 | 
			
		||||
		Code:   408,
 | 
			
		||||
		Detail: fmt.Sprintf(format, a...),
 | 
			
		||||
		Detail: fmt.Sprintf(format, args...),
 | 
			
		||||
		Status: http.StatusText(408),
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Conflict generates a 409 error.
 | 
			
		||||
func Conflict(id, format string, a ...interface{}) error {
 | 
			
		||||
func Conflict(id, format string, args ...interface{}) error {
 | 
			
		||||
	return &Error{
 | 
			
		||||
		Id:     id,
 | 
			
		||||
		ID:     id,
 | 
			
		||||
		Code:   409,
 | 
			
		||||
		Detail: fmt.Sprintf(format, a...),
 | 
			
		||||
		Detail: fmt.Sprintf(format, args...),
 | 
			
		||||
		Status: http.StatusText(409),
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// InternalServerError generates a 500 error.
 | 
			
		||||
func InternalServerError(id, format string, a ...interface{}) error {
 | 
			
		||||
func InternalServerError(id, format string, args ...interface{}) error {
 | 
			
		||||
	return &Error{
 | 
			
		||||
		Id:     id,
 | 
			
		||||
		ID:     id,
 | 
			
		||||
		Code:   500,
 | 
			
		||||
		Detail: fmt.Sprintf(format, a...),
 | 
			
		||||
		Detail: fmt.Sprintf(format, args...),
 | 
			
		||||
		Status: http.StatusText(500),
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NotImplemented generates a 501 error
 | 
			
		||||
func NotImplemented(id, format string, a ...interface{}) error {
 | 
			
		||||
func NotImplemented(id, format string, args ...interface{}) error {
 | 
			
		||||
	return &Error{
 | 
			
		||||
		Id:     id,
 | 
			
		||||
		ID:     id,
 | 
			
		||||
		Code:   501,
 | 
			
		||||
		Detail: fmt.Sprintf(format, a...),
 | 
			
		||||
		Detail: fmt.Sprintf(format, args...),
 | 
			
		||||
		Status: http.StatusText(501),
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// BadGateway generates a 502 error
 | 
			
		||||
func BadGateway(id, format string, a ...interface{}) error {
 | 
			
		||||
func BadGateway(id, format string, args ...interface{}) error {
 | 
			
		||||
	return &Error{
 | 
			
		||||
		Id:     id,
 | 
			
		||||
		ID:     id,
 | 
			
		||||
		Code:   502,
 | 
			
		||||
		Detail: fmt.Sprintf(format, a...),
 | 
			
		||||
		Detail: fmt.Sprintf(format, args...),
 | 
			
		||||
		Status: http.StatusText(502),
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// ServiceUnavailable generates a 503 error
 | 
			
		||||
func ServiceUnavailable(id, format string, a ...interface{}) error {
 | 
			
		||||
func ServiceUnavailable(id, format string, args ...interface{}) error {
 | 
			
		||||
	return &Error{
 | 
			
		||||
		Id:     id,
 | 
			
		||||
		ID:     id,
 | 
			
		||||
		Code:   503,
 | 
			
		||||
		Detail: fmt.Sprintf(format, a...),
 | 
			
		||||
		Detail: fmt.Sprintf(format, args...),
 | 
			
		||||
		Status: http.StatusText(503),
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// GatewayTimeout generates a 504 error
 | 
			
		||||
func GatewayTimeout(id, format string, a ...interface{}) error {
 | 
			
		||||
func GatewayTimeout(id, format string, args ...interface{}) error {
 | 
			
		||||
	return &Error{
 | 
			
		||||
		Id:     id,
 | 
			
		||||
		ID:     id,
 | 
			
		||||
		Code:   504,
 | 
			
		||||
		Detail: fmt.Sprintf(format, a...),
 | 
			
		||||
		Detail: fmt.Sprintf(format, args...),
 | 
			
		||||
		Status: http.StatusText(504),
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
@@ -210,11 +253,246 @@ func Equal(err1 error, err2 error) bool {
 | 
			
		||||
	return true
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// CodeIn return true if err has specified code
 | 
			
		||||
func CodeIn(err interface{}, codes ...int32) bool {
 | 
			
		||||
	var code int32
 | 
			
		||||
	switch verr := err.(type) {
 | 
			
		||||
	case *Error:
 | 
			
		||||
		code = verr.Code
 | 
			
		||||
	case int32:
 | 
			
		||||
		code = verr
 | 
			
		||||
	default:
 | 
			
		||||
		return false
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	for _, check := range codes {
 | 
			
		||||
		if code == check {
 | 
			
		||||
			return true
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return false
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// FromError try to convert go error to *Error
 | 
			
		||||
func FromError(err error) *Error {
 | 
			
		||||
	if err == nil {
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if verr, ok := err.(*Error); ok && verr != nil {
 | 
			
		||||
		return verr
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return Parse(err.Error())
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// MarshalJSON returns error data
 | 
			
		||||
func (e *Error) MarshalJSON() ([]byte, error) {
 | 
			
		||||
	return e.Marshal()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// UnmarshalJSON set error data
 | 
			
		||||
func (e *Error) UnmarshalJSON(data []byte) error {
 | 
			
		||||
	return e.Unmarshal(data)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// ProtoMessage noop func
 | 
			
		||||
func (e *Error) ProtoMessage() {}
 | 
			
		||||
 | 
			
		||||
// Reset resets error
 | 
			
		||||
func (e *Error) Reset() {
 | 
			
		||||
	*e = Error{}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// String returns error as string
 | 
			
		||||
func (e *Error) String() string {
 | 
			
		||||
	return fmt.Sprintf(`{"id":"%s","detail":"%s","status":"%s","code":%d}`, addslashes(e.ID), addslashes(e.Detail), addslashes(e.Status), e.Code)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Marshal returns error data
 | 
			
		||||
func (e *Error) Marshal() ([]byte, error) {
 | 
			
		||||
	return []byte(e.String()), nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Unmarshal set error data
 | 
			
		||||
func (e *Error) Unmarshal(data []byte) error {
 | 
			
		||||
	str := string(data)
 | 
			
		||||
	if len(data) < 41 {
 | 
			
		||||
		return fmt.Errorf("invalid data")
 | 
			
		||||
	}
 | 
			
		||||
	parts := strings.FieldsFunc(str[1:len(str)-1], func(r rune) bool {
 | 
			
		||||
		return r == ','
 | 
			
		||||
	})
 | 
			
		||||
	for _, part := range parts {
 | 
			
		||||
		nparts := strings.FieldsFunc(part, func(r rune) bool {
 | 
			
		||||
			return r == ':'
 | 
			
		||||
		})
 | 
			
		||||
		for idx := 0; idx < len(nparts)/2; idx += 2 {
 | 
			
		||||
			val := strings.Trim(nparts[idx+1], `"`)
 | 
			
		||||
			if len(val) == 0 {
 | 
			
		||||
				continue
 | 
			
		||||
			}
 | 
			
		||||
			switch {
 | 
			
		||||
			case nparts[idx] == `"id"`:
 | 
			
		||||
				e.ID = val
 | 
			
		||||
			case nparts[idx] == `"detail"`:
 | 
			
		||||
				e.Detail = val
 | 
			
		||||
			case nparts[idx] == `"status"`:
 | 
			
		||||
				e.Status = val
 | 
			
		||||
			case nparts[idx] == `"code"`:
 | 
			
		||||
				c, err := strconv.ParseInt(val, 10, 32)
 | 
			
		||||
				if err != nil {
 | 
			
		||||
					return err
 | 
			
		||||
				}
 | 
			
		||||
				e.Code = int32(c)
 | 
			
		||||
			}
 | 
			
		||||
			idx++
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func addslashes(str string) string {
 | 
			
		||||
	var buf bytes.Buffer
 | 
			
		||||
	for _, char := range str {
 | 
			
		||||
		switch char {
 | 
			
		||||
		case '\'', '"', '\\':
 | 
			
		||||
			buf.WriteRune('\\')
 | 
			
		||||
		}
 | 
			
		||||
		buf.WriteRune(char)
 | 
			
		||||
	}
 | 
			
		||||
	return buf.String()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
type retryableError struct {
 | 
			
		||||
	err error
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Retryable returns error that can be retried later
 | 
			
		||||
func Retryable(err error) error {
 | 
			
		||||
	return &retryableError{err: err}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
type IsRetryableFunc func(error) bool
 | 
			
		||||
 | 
			
		||||
var (
 | 
			
		||||
	RetrayableOracleErrors = []IsRetryableFunc{
 | 
			
		||||
		func(err error) bool {
 | 
			
		||||
			errmsg := err.Error()
 | 
			
		||||
			switch {
 | 
			
		||||
			case strings.Contains(errmsg, `ORA-`):
 | 
			
		||||
				return true
 | 
			
		||||
			case strings.Contains(errmsg, `can not assign`):
 | 
			
		||||
				return true
 | 
			
		||||
			case strings.Contains(errmsg, `can't assign`):
 | 
			
		||||
				return true
 | 
			
		||||
			}
 | 
			
		||||
			return false
 | 
			
		||||
		},
 | 
			
		||||
	}
 | 
			
		||||
	RetrayablePostgresErrors = []IsRetryableFunc{
 | 
			
		||||
		func(err error) bool {
 | 
			
		||||
			errmsg := err.Error()
 | 
			
		||||
			switch {
 | 
			
		||||
			case strings.Contains(errmsg, `number of field descriptions must equal number of`):
 | 
			
		||||
				return true
 | 
			
		||||
			case strings.Contains(errmsg, `not a pointer`):
 | 
			
		||||
				return true
 | 
			
		||||
			case strings.Contains(errmsg, `values, but dst struct has only`):
 | 
			
		||||
				return true
 | 
			
		||||
			case strings.Contains(errmsg, `struct doesn't have corresponding row field`):
 | 
			
		||||
				return true
 | 
			
		||||
			case strings.Contains(errmsg, `cannot find field`):
 | 
			
		||||
				return true
 | 
			
		||||
			case strings.Contains(errmsg, `cannot scan`) || strings.Contains(errmsg, `cannot convert`):
 | 
			
		||||
				return true
 | 
			
		||||
			case strings.Contains(errmsg, `failed to connect to`):
 | 
			
		||||
				return true
 | 
			
		||||
			}
 | 
			
		||||
			return false
 | 
			
		||||
		},
 | 
			
		||||
	}
 | 
			
		||||
	RetryableMicroErrors = []IsRetryableFunc{
 | 
			
		||||
		func(err error) bool {
 | 
			
		||||
			switch verr := err.(type) {
 | 
			
		||||
			case *Error:
 | 
			
		||||
				switch verr.Code {
 | 
			
		||||
				case 401, 403, 408, 500, 501, 502, 503, 504:
 | 
			
		||||
					return true
 | 
			
		||||
				default:
 | 
			
		||||
					return false
 | 
			
		||||
				}
 | 
			
		||||
			case *retryableError:
 | 
			
		||||
				return true
 | 
			
		||||
			}
 | 
			
		||||
			return false
 | 
			
		||||
		},
 | 
			
		||||
	}
 | 
			
		||||
	RetryableGoErrors = []IsRetryableFunc{
 | 
			
		||||
		func(err error) bool {
 | 
			
		||||
			switch verr := err.(type) {
 | 
			
		||||
			case interface{ SafeToRetry() bool }:
 | 
			
		||||
				return verr.SafeToRetry()
 | 
			
		||||
			case interface{ Timeout() bool }:
 | 
			
		||||
				return verr.Timeout()
 | 
			
		||||
			}
 | 
			
		||||
			switch {
 | 
			
		||||
			case errors.Is(err, io.EOF), errors.Is(err, io.ErrUnexpectedEOF):
 | 
			
		||||
				return true
 | 
			
		||||
			case errors.Is(err, context.DeadlineExceeded):
 | 
			
		||||
				return true
 | 
			
		||||
			case errors.Is(err, io.ErrClosedPipe), errors.Is(err, io.ErrShortBuffer), errors.Is(err, io.ErrShortWrite):
 | 
			
		||||
				return true
 | 
			
		||||
			}
 | 
			
		||||
			return false
 | 
			
		||||
		},
 | 
			
		||||
	}
 | 
			
		||||
	RetryableGrpcErrors = []IsRetryableFunc{
 | 
			
		||||
		func(err error) bool {
 | 
			
		||||
			st, ok := status.FromError(err)
 | 
			
		||||
			if !ok {
 | 
			
		||||
				return false
 | 
			
		||||
			}
 | 
			
		||||
			switch st.Code() {
 | 
			
		||||
			case codes.Unavailable, codes.ResourceExhausted:
 | 
			
		||||
				return true
 | 
			
		||||
			case codes.DeadlineExceeded:
 | 
			
		||||
				return true
 | 
			
		||||
			case codes.Internal:
 | 
			
		||||
				switch {
 | 
			
		||||
				case strings.Contains(st.Message(), `transport: received the unexpected content-type "text/html; charset=UTF-8"`):
 | 
			
		||||
					return true
 | 
			
		||||
				case strings.Contains(st.Message(), io.ErrUnexpectedEOF.Error()):
 | 
			
		||||
					return true
 | 
			
		||||
				case strings.Contains(st.Message(), `stream terminated by RST_STREAM with error code: INTERNAL_ERROR`):
 | 
			
		||||
					return true
 | 
			
		||||
				}
 | 
			
		||||
			}
 | 
			
		||||
			return false
 | 
			
		||||
		},
 | 
			
		||||
	}
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Unwrap provides error wrapping
 | 
			
		||||
func (e *retryableError) Unwrap() error {
 | 
			
		||||
	return e.err
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Error returns the error string
 | 
			
		||||
func (e *retryableError) Error() string {
 | 
			
		||||
	if e.err == nil {
 | 
			
		||||
		return ""
 | 
			
		||||
	}
 | 
			
		||||
	return e.err.Error()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// IsRetryable checks error for ability to retry later
 | 
			
		||||
func IsRetryable(err error, fns ...IsRetryableFunc) bool {
 | 
			
		||||
	for _, fn := range fns {
 | 
			
		||||
		if ok := fn(err); ok {
 | 
			
		||||
			return true
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
	return false
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										31
									
								
								errors/errors.proto
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										31
									
								
								errors/errors.proto
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,31 @@
 | 
			
		||||
// Copyright 2021 Unistack LLC
 | 
			
		||||
//
 | 
			
		||||
// Licensed under the Apache License, Version 2.0 (the "License");
 | 
			
		||||
// you may not use this file except in compliance with the License.
 | 
			
		||||
// You may obtain a copy of the License at
 | 
			
		||||
//
 | 
			
		||||
//     http://www.apache.org/licenses/LICENSE-2.0
 | 
			
		||||
//
 | 
			
		||||
// Unless required by applicable law or agreed to in writing, software
 | 
			
		||||
// distributed under the License is distributed on an "AS IS" BASIS,
 | 
			
		||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 | 
			
		||||
// See the License for the specific language governing permissions and
 | 
			
		||||
// limitations under the License.
 | 
			
		||||
 | 
			
		||||
syntax = "proto3";
 | 
			
		||||
 | 
			
		||||
package micro.errors;
 | 
			
		||||
 | 
			
		||||
option cc_enable_arenas = true;
 | 
			
		||||
option go_package = "go.unistack.org/micro/v4/errors;errors";
 | 
			
		||||
option java_multiple_files = true;
 | 
			
		||||
option java_outer_classname = "MicroErrors";
 | 
			
		||||
option java_package = "micro.errors";
 | 
			
		||||
option objc_class_prefix = "MERRORS";
 | 
			
		||||
 | 
			
		||||
message Error {
 | 
			
		||||
  string id = 1;
 | 
			
		||||
  string detail = 2;
 | 
			
		||||
  string status = 3;
 | 
			
		||||
  uint32 code = 4;
 | 
			
		||||
}
 | 
			
		||||
@@ -1,23 +1,52 @@
 | 
			
		||||
package errors
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	er "errors"
 | 
			
		||||
	"encoding/json"
 | 
			
		||||
	"errors"
 | 
			
		||||
	"fmt"
 | 
			
		||||
	"net/http"
 | 
			
		||||
	"testing"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
func TestIsRetrayable(t *testing.T) {
 | 
			
		||||
	err := fmt.Errorf("ORA-")
 | 
			
		||||
	if !IsRetryable(err, RetrayableOracleErrors...) {
 | 
			
		||||
		t.Fatalf("IsRetrayable not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestMarshalJSON(t *testing.T) {
 | 
			
		||||
	e := InternalServerError("id", "err: %v", fmt.Errorf("err: %v", `xxx: "UNIX_TIMESTAMP": invalid identifier`))
 | 
			
		||||
	_, err := json.Marshal(e)
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		t.Fatal(err)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestEmpty(t *testing.T) {
 | 
			
		||||
	msg := "test"
 | 
			
		||||
	var err *Error
 | 
			
		||||
	err = FromError(errors.New(msg))
 | 
			
		||||
	if err.Detail != msg {
 | 
			
		||||
		t.Fatalf("invalid error %v", err)
 | 
			
		||||
	}
 | 
			
		||||
	err = FromError(fmt.Errorf(`{"id":"","detail":"%s","status":"%s","code":0}`, msg, msg))
 | 
			
		||||
	if err.Detail != msg || err.Status != msg {
 | 
			
		||||
		t.Fatalf("invalid error %#+v", err)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestFromError(t *testing.T) {
 | 
			
		||||
	err := NotFound("go.micro.test", "%s", "example")
 | 
			
		||||
	merr := FromError(err)
 | 
			
		||||
	if merr.Id != "go.micro.test" || merr.Code != 404 {
 | 
			
		||||
	if merr.ID != "go.micro.test" || merr.Code != 404 {
 | 
			
		||||
		t.Fatalf("invalid conversation %v != %v", err, merr)
 | 
			
		||||
	}
 | 
			
		||||
	err = er.New(err.Error())
 | 
			
		||||
	err = errors.New(err.Error())
 | 
			
		||||
	merr = FromError(err)
 | 
			
		||||
	if merr.Id != "go.micro.test" || merr.Code != 404 {
 | 
			
		||||
	if merr.ID != "go.micro.test" || merr.Code != 404 {
 | 
			
		||||
		t.Fatalf("invalid conversation %v != %v", err, merr)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestEqual(t *testing.T) {
 | 
			
		||||
@@ -28,17 +57,16 @@ func TestEqual(t *testing.T) {
 | 
			
		||||
		t.Fatal("errors must be equal")
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	err3 := er.New("my test err")
 | 
			
		||||
	err3 := errors.New("my test err")
 | 
			
		||||
	if Equal(err1, err3) {
 | 
			
		||||
		t.Fatal("errors must be not equal")
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestErrors(t *testing.T) {
 | 
			
		||||
	testData := []*Error{
 | 
			
		||||
		{
 | 
			
		||||
			Id:     "test",
 | 
			
		||||
			ID:     "test",
 | 
			
		||||
			Code:   500,
 | 
			
		||||
			Detail: "Internal server error",
 | 
			
		||||
			Status: http.StatusText(500),
 | 
			
		||||
@@ -46,7 +74,7 @@ func TestErrors(t *testing.T) {
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	for _, e := range testData {
 | 
			
		||||
		ne := New(e.Id, e.Detail, e.Code)
 | 
			
		||||
		ne := New(e.ID, e.Detail, e.Code)
 | 
			
		||||
 | 
			
		||||
		if e.Error() != ne.Error() {
 | 
			
		||||
			t.Fatalf("Expected %s got %s", e.Error(), ne.Error())
 | 
			
		||||
@@ -58,8 +86,8 @@ func TestErrors(t *testing.T) {
 | 
			
		||||
			t.Fatalf("Expected error got nil %v", pe)
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		if pe.Id != e.Id {
 | 
			
		||||
			t.Fatalf("Expected %s got %s", e.Id, pe.Id)
 | 
			
		||||
		if pe.ID != e.ID {
 | 
			
		||||
			t.Fatalf("Expected %s got %s", e.ID, pe.ID)
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		if pe.Detail != e.Detail {
 | 
			
		||||
@@ -75,3 +103,19 @@ func TestErrors(t *testing.T) {
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestCodeIn(t *testing.T) {
 | 
			
		||||
	err := InternalServerError("id", "%s", "msg")
 | 
			
		||||
 | 
			
		||||
	if ok := CodeIn(err, 400, 500); !ok {
 | 
			
		||||
		t.Fatalf("CodeIn not works: %v", err)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if ok := CodeIn(err.(*Error).Code, 500); !ok {
 | 
			
		||||
		t.Fatalf("CodeIn not works: %v", err)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if ok := CodeIn(err, 100); ok {
 | 
			
		||||
		t.Fatalf("CodeIn not works: %v", err)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										27
									
								
								event.go
									
									
									
									
									
								
							
							
						
						
									
										27
									
								
								event.go
									
									
									
									
									
								
							@@ -1,27 +0,0 @@
 | 
			
		||||
package micro
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
 | 
			
		||||
	"github.com/unistack-org/micro/v3/client"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Event is used to publish messages to a topic
 | 
			
		||||
type Event interface {
 | 
			
		||||
	// Publish publishes a message to the event topic
 | 
			
		||||
	Publish(ctx context.Context, msg interface{}, opts ...client.PublishOption) error
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
type event struct {
 | 
			
		||||
	c     client.Client
 | 
			
		||||
	topic string
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewEvent creates a new event publisher
 | 
			
		||||
func NewEvent(topic string, c client.Client) Event {
 | 
			
		||||
	return &event{c, topic}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (e *event) Publish(ctx context.Context, msg interface{}, opts ...client.PublishOption) error {
 | 
			
		||||
	return e.c.Publish(ctx, e.c.NewMessage(e.topic, msg), opts...)
 | 
			
		||||
}
 | 
			
		||||
@@ -1,26 +1,26 @@
 | 
			
		||||
package transport
 | 
			
		||||
package flow
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
type transportKey struct{}
 | 
			
		||||
type flowKey struct{}
 | 
			
		||||
 | 
			
		||||
// FromContext get transport from context
 | 
			
		||||
func FromContext(ctx context.Context) (Transport, bool) {
 | 
			
		||||
// FromContext returns Flow from context
 | 
			
		||||
func FromContext(ctx context.Context) (Flow, bool) {
 | 
			
		||||
	if ctx == nil {
 | 
			
		||||
		return nil, false
 | 
			
		||||
	}
 | 
			
		||||
	c, ok := ctx.Value(transportKey{}).(Transport)
 | 
			
		||||
	c, ok := ctx.Value(flowKey{}).(Flow)
 | 
			
		||||
	return c, ok
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewContext put transport in context
 | 
			
		||||
func NewContext(ctx context.Context, c Transport) context.Context {
 | 
			
		||||
// NewContext stores Flow to context
 | 
			
		||||
func NewContext(ctx context.Context, f Flow) context.Context {
 | 
			
		||||
	if ctx == nil {
 | 
			
		||||
		ctx = context.Background()
 | 
			
		||||
	}
 | 
			
		||||
	return context.WithValue(ctx, transportKey{}, c)
 | 
			
		||||
	return context.WithValue(ctx, flowKey{}, f)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SetOption returns a function to setup a context with given value
 | 
			
		||||
							
								
								
									
										55
									
								
								flow/context_test.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										55
									
								
								flow/context_test.go
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,55 @@
 | 
			
		||||
//go:build ignore
 | 
			
		||||
 | 
			
		||||
package flow
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"testing"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
func TestFromNilContext(t *testing.T) {
 | 
			
		||||
	// nolint: staticcheck
 | 
			
		||||
	c, ok := FromContext(nil)
 | 
			
		||||
	if ok || c != nil {
 | 
			
		||||
		t.Fatal("FromContext not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestNewNilContext(t *testing.T) {
 | 
			
		||||
	// nolint: staticcheck
 | 
			
		||||
	ctx := NewContext(nil, NewFlow())
 | 
			
		||||
 | 
			
		||||
	c, ok := FromContext(ctx)
 | 
			
		||||
	if c == nil || !ok {
 | 
			
		||||
		t.Fatal("NewContext not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestFromContext(t *testing.T) {
 | 
			
		||||
	ctx := context.WithValue(context.TODO(), flowKey{}, NewFlow())
 | 
			
		||||
 | 
			
		||||
	c, ok := FromContext(ctx)
 | 
			
		||||
	if c == nil || !ok {
 | 
			
		||||
		t.Fatal("FromContext not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestNewContext(t *testing.T) {
 | 
			
		||||
	ctx := NewContext(context.TODO(), NewFlow())
 | 
			
		||||
 | 
			
		||||
	c, ok := FromContext(ctx)
 | 
			
		||||
	if c == nil || !ok {
 | 
			
		||||
		t.Fatal("NewContext not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestSetOption(t *testing.T) {
 | 
			
		||||
	type key struct{}
 | 
			
		||||
	o := SetOption(key{}, "test")
 | 
			
		||||
	opts := &Options{}
 | 
			
		||||
	o(opts)
 | 
			
		||||
 | 
			
		||||
	if v, ok := opts.Context.Value(key{}).(string); !ok || v == "" {
 | 
			
		||||
		t.Fatal("SetOption not works")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
@@ -7,6 +7,56 @@ import (
 | 
			
		||||
	"github.com/silas/dag"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
func TestDeps(t *testing.T) {
 | 
			
		||||
	t.Skip()
 | 
			
		||||
	d := &dag.AcyclicGraph{}
 | 
			
		||||
 | 
			
		||||
	v0 := d.Add(&node{"v0"})
 | 
			
		||||
	v1 := d.Add(&node{"v1"})
 | 
			
		||||
	v2 := d.Add(&node{"v2"})
 | 
			
		||||
	v3 := d.Add(&node{"v3"})
 | 
			
		||||
	v4 := d.Add(&node{"v4"})
 | 
			
		||||
 | 
			
		||||
	d.Connect(dag.BasicEdge(v0, v1))
 | 
			
		||||
	d.Connect(dag.BasicEdge(v1, v2))
 | 
			
		||||
	d.Connect(dag.BasicEdge(v2, v4))
 | 
			
		||||
	d.Connect(dag.BasicEdge(v0, v3))
 | 
			
		||||
	d.Connect(dag.BasicEdge(v3, v4))
 | 
			
		||||
 | 
			
		||||
	if err := d.Validate(); err != nil {
 | 
			
		||||
		t.Fatal(err)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	d.TransitiveReduction()
 | 
			
		||||
 | 
			
		||||
	var steps [][]string
 | 
			
		||||
	fn := func(n dag.Vertex, idx int) error {
 | 
			
		||||
		if idx == 0 {
 | 
			
		||||
			steps = make([][]string, 1)
 | 
			
		||||
			steps[0] = make([]string, 0, 1)
 | 
			
		||||
		} else if idx >= len(steps) {
 | 
			
		||||
			tsteps := make([][]string, idx+1)
 | 
			
		||||
			copy(tsteps, steps)
 | 
			
		||||
			steps = tsteps
 | 
			
		||||
			steps[idx] = make([]string, 0, 1)
 | 
			
		||||
		}
 | 
			
		||||
		steps[idx] = append(steps[idx], fmt.Sprintf("%s", n))
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	start := &node{"v0"}
 | 
			
		||||
	err := d.SortedDepthFirstWalk([]dag.Vertex{start}, fn)
 | 
			
		||||
	checkErr(t, err)
 | 
			
		||||
 | 
			
		||||
	for idx, steps := range steps {
 | 
			
		||||
		fmt.Printf("level %d steps %#+v\n", idx, steps)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if len(steps[2]) != 1 {
 | 
			
		||||
		t.Logf("invalid steps %#+v", steps[2])
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func checkErr(t *testing.T, err error) {
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		t.Fatal(err)
 | 
			
		||||
@@ -44,10 +94,10 @@ func TestDag(t *testing.T) {
 | 
			
		||||
	var steps [][]string
 | 
			
		||||
	fn := func(n dag.Vertex, idx int) error {
 | 
			
		||||
		if idx == 0 {
 | 
			
		||||
			steps = make([][]string, 1, 1)
 | 
			
		||||
			steps = make([][]string, 1)
 | 
			
		||||
			steps[0] = make([]string, 0, 1)
 | 
			
		||||
		} else if idx >= len(steps) {
 | 
			
		||||
			tsteps := make([][]string, idx+1, idx+1)
 | 
			
		||||
			tsteps := make([][]string, idx+1)
 | 
			
		||||
			copy(tsteps, steps)
 | 
			
		||||
			steps = tsteps
 | 
			
		||||
			steps[idx] = make([]string, 0, 1)
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										641
									
								
								flow/default.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										641
									
								
								flow/default.go
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,641 @@
 | 
			
		||||
//go:build ignore
 | 
			
		||||
 | 
			
		||||
package flow
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"fmt"
 | 
			
		||||
	"path/filepath"
 | 
			
		||||
	"sync"
 | 
			
		||||
 | 
			
		||||
	"github.com/heimdalr/dag"
 | 
			
		||||
	"go.unistack.org/micro/v4/client"
 | 
			
		||||
	"go.unistack.org/micro/v4/codec"
 | 
			
		||||
	"go.unistack.org/micro/v4/metadata"
 | 
			
		||||
	"go.unistack.org/micro/v4/store"
 | 
			
		||||
	"go.unistack.org/micro/v4/util/id"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
type microFlow struct {
 | 
			
		||||
	opts Options
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
type microWorkflow struct {
 | 
			
		||||
	opts   Options
 | 
			
		||||
	g      *dag.DAG
 | 
			
		||||
	steps  map[string]Step
 | 
			
		||||
	id     string
 | 
			
		||||
	status Status
 | 
			
		||||
	sync.RWMutex
 | 
			
		||||
	init bool
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (w *microWorkflow) ID() string {
 | 
			
		||||
	return w.id
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (w *microWorkflow) Status() Status {
 | 
			
		||||
	return w.status
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (w *microWorkflow) AppendSteps(steps ...Step) error {
 | 
			
		||||
	var err error
 | 
			
		||||
	w.Lock()
 | 
			
		||||
	defer w.Unlock()
 | 
			
		||||
 | 
			
		||||
	for _, s := range steps {
 | 
			
		||||
		w.steps[s.String()] = s
 | 
			
		||||
		if _, err = w.g.AddVertex(s); err != nil {
 | 
			
		||||
			return err
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	for _, dst := range steps {
 | 
			
		||||
		for _, req := range dst.Requires() {
 | 
			
		||||
			src, ok := w.steps[req]
 | 
			
		||||
			if !ok {
 | 
			
		||||
				return ErrStepNotExists
 | 
			
		||||
			}
 | 
			
		||||
			if err = w.g.AddEdge(src.String(), dst.String()); err != nil {
 | 
			
		||||
				return err
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	w.g.ReduceTransitively()
 | 
			
		||||
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (w *microWorkflow) RemoveSteps(steps ...Step) error {
 | 
			
		||||
	// TODO: handle case when some step requires or required by removed step
 | 
			
		||||
 | 
			
		||||
	w.Lock()
 | 
			
		||||
	defer w.Unlock()
 | 
			
		||||
 | 
			
		||||
	for _, s := range steps {
 | 
			
		||||
		delete(w.steps, s.String())
 | 
			
		||||
		w.g.DeleteVertex(s.String())
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	for _, dst := range steps {
 | 
			
		||||
		for _, req := range dst.Requires() {
 | 
			
		||||
			src, ok := w.steps[req]
 | 
			
		||||
			if !ok {
 | 
			
		||||
				return ErrStepNotExists
 | 
			
		||||
			}
 | 
			
		||||
			w.g.AddEdge(src.String(), dst.String())
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	w.g.ReduceTransitively()
 | 
			
		||||
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (w *microWorkflow) Abort(ctx context.Context, id string) error {
 | 
			
		||||
	workflowStore := store.NewNamespaceStore(w.opts.Store, filepath.Join("workflows", id))
 | 
			
		||||
	return workflowStore.Write(ctx, "status", &codec.Frame{Data: []byte(StatusAborted.String())})
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (w *microWorkflow) Suspend(ctx context.Context, id string) error {
 | 
			
		||||
	workflowStore := store.NewNamespaceStore(w.opts.Store, filepath.Join("workflows", id))
 | 
			
		||||
	return workflowStore.Write(ctx, "status", &codec.Frame{Data: []byte(StatusSuspend.String())})
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (w *microWorkflow) Resume(ctx context.Context, id string) error {
 | 
			
		||||
	workflowStore := store.NewNamespaceStore(w.opts.Store, filepath.Join("workflows", id))
 | 
			
		||||
	return workflowStore.Write(ctx, "status", &codec.Frame{Data: []byte(StatusRunning.String())})
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (w *microWorkflow) Execute(ctx context.Context, req *Message, opts ...ExecuteOption) (string, error) {
 | 
			
		||||
	w.Lock()
 | 
			
		||||
	if !w.init {
 | 
			
		||||
		w.g.ReduceTransitively()
 | 
			
		||||
		w.init = true
 | 
			
		||||
	}
 | 
			
		||||
	w.Unlock()
 | 
			
		||||
 | 
			
		||||
	eid, err := id.New()
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		return "", err
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	//	stepStore := store.NewNamespaceStore(w.opts.Store, filepath.Join("steps", eid))
 | 
			
		||||
	workflowStore := store.NewNamespaceStore(w.opts.Store, filepath.Join("workflows", eid))
 | 
			
		||||
 | 
			
		||||
	options := NewExecuteOptions(opts...)
 | 
			
		||||
 | 
			
		||||
	nopts := make([]ExecuteOption, 0, len(opts)+5)
 | 
			
		||||
 | 
			
		||||
	nopts = append(nopts,
 | 
			
		||||
		ExecuteClient(w.opts.Client),
 | 
			
		||||
		ExecuteTracer(w.opts.Tracer),
 | 
			
		||||
		ExecuteLogger(w.opts.Logger),
 | 
			
		||||
		ExecuteMeter(w.opts.Meter),
 | 
			
		||||
	)
 | 
			
		||||
	nopts = append(nopts, opts...)
 | 
			
		||||
 | 
			
		||||
	if werr := workflowStore.Write(ctx, "status", &codec.Frame{Data: []byte(StatusRunning.String())}); werr != nil {
 | 
			
		||||
		w.opts.Logger.Error(ctx, "store error: %v", werr)
 | 
			
		||||
		return eid, werr
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	var startID string
 | 
			
		||||
	if options.Start == "" {
 | 
			
		||||
		mp := w.g.GetRoots()
 | 
			
		||||
		if len(mp) != 1 {
 | 
			
		||||
			return eid, ErrStepNotExists
 | 
			
		||||
		}
 | 
			
		||||
		for k := range mp {
 | 
			
		||||
			startID = k
 | 
			
		||||
		}
 | 
			
		||||
	} else {
 | 
			
		||||
		for k, v := range w.g.GetVertices() {
 | 
			
		||||
			if v == options.Start {
 | 
			
		||||
				startID = k
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if startID == "" {
 | 
			
		||||
		return eid, ErrStepNotExists
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if options.Async {
 | 
			
		||||
		go w.handleWorkflow(startID, nopts...)
 | 
			
		||||
		return eid, nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return eid, w.handleWorkflow(startID, nopts...)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (w *microWorkflow) handleWorkflow(startID string, opts ...ExecuteOption) error {
 | 
			
		||||
	w.RLock()
 | 
			
		||||
	defer w.RUnlock()
 | 
			
		||||
 | 
			
		||||
	//	stepStore := store.NewNamespaceStore(w.opts.Store, filepath.Join("steps", eid))
 | 
			
		||||
	// workflowStore := store.NewNamespaceStore(w.opts.Store, filepath.Join("workflows", eid))
 | 
			
		||||
 | 
			
		||||
	// Get IDs of all descendant vertices.
 | 
			
		||||
	flowIDs, errDes := w.g.GetDescendants(startID)
 | 
			
		||||
	if errDes != nil {
 | 
			
		||||
		return errDes
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// inputChannels provides for input channels for each of the descendant vertices (+ the start-vertex).
 | 
			
		||||
	inputChannels := make(map[string]chan FlowResult, len(flowIDs)+1)
 | 
			
		||||
 | 
			
		||||
	// Iterate vertex IDs and create an input channel for each of them and a single
 | 
			
		||||
	// output channel for leaves. Note, this "pre-flight" is needed to ensure we
 | 
			
		||||
	// really have an input channel regardless of how we traverse the tree and spawn
 | 
			
		||||
	// workers.
 | 
			
		||||
	leafCount := 0
 | 
			
		||||
 | 
			
		||||
	for id := range flowIDs {
 | 
			
		||||
 | 
			
		||||
		// Get all parents of this vertex.
 | 
			
		||||
		parents, errPar := w.g.GetParents(id)
 | 
			
		||||
		if errPar != nil {
 | 
			
		||||
			return errPar
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		// Create a buffered input channel that has capacity for all parent results.
 | 
			
		||||
		inputChannels[id] = make(chan FlowResult, len(parents))
 | 
			
		||||
 | 
			
		||||
		if ok, err := w.g.IsLeaf(id); ok && err == nil {
 | 
			
		||||
			leafCount += 1
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// outputChannel caries the results of leaf vertices.
 | 
			
		||||
	outputChannel := make(chan FlowResult, leafCount)
 | 
			
		||||
 | 
			
		||||
	// To also process the start vertex and to have its results being passed to its
 | 
			
		||||
	// children, add it to the vertex IDs. Also add an input channel for the start
 | 
			
		||||
	// vertex and feed the inputs to this channel.
 | 
			
		||||
	flowIDs[startID] = struct{}{}
 | 
			
		||||
	inputChannels[startID] = make(chan FlowResult, len(inputs))
 | 
			
		||||
	for _, i := range inputs {
 | 
			
		||||
		inputChannels[startID] <- i
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	wg := sync.WaitGroup{}
 | 
			
		||||
 | 
			
		||||
	// Iterate all vertex IDs (now incl. start vertex) and handle each worker (incl.
 | 
			
		||||
	// inputs and outputs) in a separate goroutine.
 | 
			
		||||
	for id := range flowIDs {
 | 
			
		||||
 | 
			
		||||
		// Get all children of this vertex that later need to be notified. Note, we
 | 
			
		||||
		// collect all children before the goroutine to be able to release the read
 | 
			
		||||
		// lock as early as possible.
 | 
			
		||||
		children, errChildren := w.g.GetChildren(id)
 | 
			
		||||
		if errChildren != nil {
 | 
			
		||||
			return errChildren
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		// Remember to wait for this goroutine.
 | 
			
		||||
		wg.Add(1)
 | 
			
		||||
 | 
			
		||||
		go func(id string) {
 | 
			
		||||
			// Get this vertex's input channel.
 | 
			
		||||
			// Note, only concurrent read here, which is fine.
 | 
			
		||||
			c := inputChannels[id]
 | 
			
		||||
 | 
			
		||||
			// Await all parent inputs and stuff them into a slice.
 | 
			
		||||
			parentCount := cap(c)
 | 
			
		||||
			parentResults := make([]FlowResult, parentCount)
 | 
			
		||||
			for i := 0; i < parentCount; i++ {
 | 
			
		||||
				parentResults[i] = <-c
 | 
			
		||||
			}
 | 
			
		||||
 | 
			
		||||
			// Execute the worker.
 | 
			
		||||
			errWorker := callback(w.g, id, parentResults)
 | 
			
		||||
			if errWorker != nil {
 | 
			
		||||
				return errWorker
 | 
			
		||||
			}
 | 
			
		||||
 | 
			
		||||
			// Send this worker's FlowResult onto all children's input channels or, if it is
 | 
			
		||||
			// a leaf (i.e. no children), send the result onto the output channel.
 | 
			
		||||
			if len(children) > 0 {
 | 
			
		||||
				for child := range children {
 | 
			
		||||
					inputChannels[child] <- flowResult
 | 
			
		||||
				}
 | 
			
		||||
			} else {
 | 
			
		||||
				outputChannel <- flowResult
 | 
			
		||||
			}
 | 
			
		||||
 | 
			
		||||
			// "Sign off".
 | 
			
		||||
			wg.Done()
 | 
			
		||||
		}(id)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// Wait for all go routines to finish.
 | 
			
		||||
	wg.Wait()
 | 
			
		||||
 | 
			
		||||
	// Await all leaf vertex results and stuff them into a slice.
 | 
			
		||||
	resultCount := cap(outputChannel)
 | 
			
		||||
	results := make([]FlowResult, resultCount)
 | 
			
		||||
	for i := 0; i < resultCount; i++ {
 | 
			
		||||
		results[i] = <-outputChannel
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	/*
 | 
			
		||||
		go func() {
 | 
			
		||||
			for idx := range steps {
 | 
			
		||||
				for nidx := range steps[idx] {
 | 
			
		||||
					wStatus := &codec.Frame{}
 | 
			
		||||
					if werr := workflowStore.Read(w.opts.Context, "status", wStatus); werr != nil {
 | 
			
		||||
						cherr <- werr
 | 
			
		||||
						return
 | 
			
		||||
					}
 | 
			
		||||
					if status := StringStatus[string(wStatus.Data)]; status != StatusRunning {
 | 
			
		||||
						chstatus <- status
 | 
			
		||||
						return
 | 
			
		||||
					}
 | 
			
		||||
					if w.opts.Logger.V(logger.TraceLevel) {
 | 
			
		||||
						w.opts.Logger.Tracef(nctx, "will be executed %v", steps[idx][nidx])
 | 
			
		||||
					}
 | 
			
		||||
					cstep := steps[idx][nidx]
 | 
			
		||||
					// nolint: nestif
 | 
			
		||||
					if len(cstep.Requires()) == 0 {
 | 
			
		||||
						wg.Add(1)
 | 
			
		||||
						go func(step Step) {
 | 
			
		||||
							defer wg.Done()
 | 
			
		||||
							if werr := stepStore.Write(ctx, filepath.Join(step.ID(), "req"), req); werr != nil {
 | 
			
		||||
								cherr <- werr
 | 
			
		||||
								return
 | 
			
		||||
							}
 | 
			
		||||
							if werr := stepStore.Write(ctx, filepath.Join(step.ID(), "status"), &codec.Frame{Data: []byte(StatusRunning.String())}); werr != nil {
 | 
			
		||||
								cherr <- werr
 | 
			
		||||
								return
 | 
			
		||||
							}
 | 
			
		||||
							rsp, serr := step.Execute(nctx, req, nopts...)
 | 
			
		||||
							if serr != nil {
 | 
			
		||||
								step.SetStatus(StatusFailure)
 | 
			
		||||
								if werr := stepStore.Write(ctx, filepath.Join(step.ID(), "rsp"), serr); werr != nil && w.opts.Logger.V(logger.ErrorLevel) {
 | 
			
		||||
									w.opts.Logger.Errorf(ctx, "store write error: %v", werr)
 | 
			
		||||
								}
 | 
			
		||||
								if werr := stepStore.Write(ctx, filepath.Join(step.ID(), "status"), &codec.Frame{Data: []byte(StatusFailure.String())}); werr != nil && w.opts.Logger.V(logger.ErrorLevel) {
 | 
			
		||||
									w.opts.Logger.Errorf(ctx, "store write error: %v", werr)
 | 
			
		||||
								}
 | 
			
		||||
								cherr <- serr
 | 
			
		||||
								return
 | 
			
		||||
							}
 | 
			
		||||
							if werr := stepStore.Write(ctx, filepath.Join(step.ID(), "rsp"), rsp); werr != nil {
 | 
			
		||||
								w.opts.Logger.Errorf(ctx, "store write error: %v", werr)
 | 
			
		||||
								cherr <- werr
 | 
			
		||||
								return
 | 
			
		||||
							}
 | 
			
		||||
							if werr := stepStore.Write(ctx, filepath.Join(step.ID(), "status"), &codec.Frame{Data: []byte(StatusSuccess.String())}); werr != nil {
 | 
			
		||||
								w.opts.Logger.Errorf(ctx, "store write error: %v", werr)
 | 
			
		||||
								cherr <- werr
 | 
			
		||||
								return
 | 
			
		||||
							}
 | 
			
		||||
						}(cstep)
 | 
			
		||||
						wg.Wait()
 | 
			
		||||
					} else {
 | 
			
		||||
						if werr := stepStore.Write(ctx, filepath.Join(cstep.ID(), "req"), req); werr != nil {
 | 
			
		||||
							cherr <- werr
 | 
			
		||||
							return
 | 
			
		||||
						}
 | 
			
		||||
						if werr := stepStore.Write(ctx, filepath.Join(cstep.ID(), "status"), &codec.Frame{Data: []byte(StatusRunning.String())}); werr != nil {
 | 
			
		||||
							cherr <- werr
 | 
			
		||||
							return
 | 
			
		||||
						}
 | 
			
		||||
						rsp, serr := cstep.Execute(nctx, req, nopts...)
 | 
			
		||||
						if serr != nil {
 | 
			
		||||
							cstep.SetStatus(StatusFailure)
 | 
			
		||||
							if werr := stepStore.Write(ctx, filepath.Join(cstep.ID(), "rsp"), serr); werr != nil && w.opts.Logger.V(logger.ErrorLevel) {
 | 
			
		||||
								w.opts.Logger.Errorf(ctx, "store write error: %v", werr)
 | 
			
		||||
							}
 | 
			
		||||
							if werr := stepStore.Write(ctx, filepath.Join(cstep.ID(), "status"), &codec.Frame{Data: []byte(StatusFailure.String())}); werr != nil && w.opts.Logger.V(logger.ErrorLevel) {
 | 
			
		||||
								w.opts.Logger.Errorf(ctx, "store write error: %v", werr)
 | 
			
		||||
							}
 | 
			
		||||
							cherr <- serr
 | 
			
		||||
							return
 | 
			
		||||
						}
 | 
			
		||||
						if werr := stepStore.Write(ctx, filepath.Join(cstep.ID(), "rsp"), rsp); werr != nil {
 | 
			
		||||
							w.opts.Logger.Errorf(ctx, "store write error: %v", werr)
 | 
			
		||||
							cherr <- werr
 | 
			
		||||
							return
 | 
			
		||||
						}
 | 
			
		||||
						if werr := stepStore.Write(ctx, filepath.Join(cstep.ID(), "status"), &codec.Frame{Data: []byte(StatusSuccess.String())}); werr != nil {
 | 
			
		||||
							cherr <- werr
 | 
			
		||||
							return
 | 
			
		||||
						}
 | 
			
		||||
					}
 | 
			
		||||
				}
 | 
			
		||||
			}
 | 
			
		||||
			close(done)
 | 
			
		||||
		}()
 | 
			
		||||
 | 
			
		||||
		if options.Async {
 | 
			
		||||
			return eid, nil
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		logger.Tracef(ctx, "wait for finish or error")
 | 
			
		||||
		select {
 | 
			
		||||
		case <-nctx.Done():
 | 
			
		||||
			err = nctx.Err()
 | 
			
		||||
		case cerr := <-cherr:
 | 
			
		||||
			err = cerr
 | 
			
		||||
		case <-done:
 | 
			
		||||
			close(cherr)
 | 
			
		||||
		case <-chstatus:
 | 
			
		||||
			close(chstatus)
 | 
			
		||||
			return eid, nil
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		switch {
 | 
			
		||||
		case nctx.Err() != nil:
 | 
			
		||||
			if werr := workflowStore.Write(w.opts.Context, "status", &codec.Frame{Data: []byte(StatusAborted.String())}); werr != nil {
 | 
			
		||||
				w.opts.Logger.Errorf(w.opts.Context, "store error: %v", werr)
 | 
			
		||||
			}
 | 
			
		||||
		case err == nil:
 | 
			
		||||
			if werr := workflowStore.Write(w.opts.Context, "status", &codec.Frame{Data: []byte(StatusSuccess.String())}); werr != nil {
 | 
			
		||||
				w.opts.Logger.Errorf(w.opts.Context, "store error: %v", werr)
 | 
			
		||||
			}
 | 
			
		||||
		case err != nil:
 | 
			
		||||
			if werr := workflowStore.Write(w.opts.Context, "status", &codec.Frame{Data: []byte(StatusFailure.String())}); werr != nil {
 | 
			
		||||
				w.opts.Logger.Errorf(w.opts.Context, "store error: %v", werr)
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
	*/
 | 
			
		||||
	return err
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewFlow create new flow
 | 
			
		||||
func NewFlow(opts ...Option) Flow {
 | 
			
		||||
	options := NewOptions(opts...)
 | 
			
		||||
	return µFlow{opts: options}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (f *microFlow) Options() Options {
 | 
			
		||||
	return f.opts
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (f *microFlow) Init(opts ...Option) error {
 | 
			
		||||
	for _, o := range opts {
 | 
			
		||||
		o(&f.opts)
 | 
			
		||||
	}
 | 
			
		||||
	if err := f.opts.Client.Init(); err != nil {
 | 
			
		||||
		return err
 | 
			
		||||
	}
 | 
			
		||||
	if err := f.opts.Tracer.Init(); err != nil {
 | 
			
		||||
		return err
 | 
			
		||||
	}
 | 
			
		||||
	if err := f.opts.Logger.Init(); err != nil {
 | 
			
		||||
		return err
 | 
			
		||||
	}
 | 
			
		||||
	if err := f.opts.Meter.Init(); err != nil {
 | 
			
		||||
		return err
 | 
			
		||||
	}
 | 
			
		||||
	if err := f.opts.Store.Init(); err != nil {
 | 
			
		||||
		return err
 | 
			
		||||
	}
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (f *microFlow) WorkflowList(ctx context.Context) ([]Workflow, error) {
 | 
			
		||||
	return nil, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (f *microFlow) WorkflowCreate(ctx context.Context, id string, steps ...Step) (Workflow, error) {
 | 
			
		||||
	w := µWorkflow{opts: f.opts, id: id, g: &dag.DAG{}, steps: make(map[string]Step, len(steps))}
 | 
			
		||||
 | 
			
		||||
	for _, s := range steps {
 | 
			
		||||
		w.steps[s.String()] = s
 | 
			
		||||
		w.g.AddVertex(s)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	for _, dst := range steps {
 | 
			
		||||
		for _, req := range dst.Requires() {
 | 
			
		||||
			src, ok := w.steps[req]
 | 
			
		||||
			if !ok {
 | 
			
		||||
				return nil, ErrStepNotExists
 | 
			
		||||
			}
 | 
			
		||||
			w.g.AddEdge(src.String(), dst.String())
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	w.g.ReduceTransitively()
 | 
			
		||||
 | 
			
		||||
	w.init = true
 | 
			
		||||
 | 
			
		||||
	return w, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (f *microFlow) WorkflowRemove(ctx context.Context, id string) error {
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (f *microFlow) WorkflowSave(ctx context.Context, w Workflow) error {
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (f *microFlow) WorkflowLoad(ctx context.Context, id string) (Workflow, error) {
 | 
			
		||||
	return nil, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
type microCallStep struct {
 | 
			
		||||
	rsp     *Message
 | 
			
		||||
	req     *Message
 | 
			
		||||
	service string
 | 
			
		||||
	method  string
 | 
			
		||||
	opts    StepOptions
 | 
			
		||||
	status  Status
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microCallStep) Request() *Message {
 | 
			
		||||
	return s.req
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microCallStep) Response() *Message {
 | 
			
		||||
	return s.rsp
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microCallStep) ID() string {
 | 
			
		||||
	return s.String()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microCallStep) Options() StepOptions {
 | 
			
		||||
	return s.opts
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microCallStep) Endpoint() string {
 | 
			
		||||
	return s.method
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microCallStep) Requires() []string {
 | 
			
		||||
	return s.opts.Requires
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microCallStep) Require(steps ...Step) error {
 | 
			
		||||
	for _, step := range steps {
 | 
			
		||||
		s.opts.Requires = append(s.opts.Requires, step.String())
 | 
			
		||||
	}
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microCallStep) String() string {
 | 
			
		||||
	if s.opts.ID != "" {
 | 
			
		||||
		return s.opts.ID
 | 
			
		||||
	}
 | 
			
		||||
	return fmt.Sprintf("%s.%s", s.service, s.method)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microCallStep) Name() string {
 | 
			
		||||
	return s.String()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microCallStep) Hashcode() interface{} {
 | 
			
		||||
	return s.String()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microCallStep) GetStatus() Status {
 | 
			
		||||
	return s.status
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microCallStep) SetStatus(status Status) {
 | 
			
		||||
	s.status = status
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microCallStep) Execute(ctx context.Context, req *Message, opts ...ExecuteOption) (*Message, error) {
 | 
			
		||||
	options := NewExecuteOptions(opts...)
 | 
			
		||||
	if options.Client == nil {
 | 
			
		||||
		return nil, ErrMissingClient
 | 
			
		||||
	}
 | 
			
		||||
	rsp := &codec.Frame{}
 | 
			
		||||
	copts := []client.CallOption{client.WithRetries(0)}
 | 
			
		||||
	if options.Timeout > 0 {
 | 
			
		||||
		copts = append(copts,
 | 
			
		||||
			client.WithRequestTimeout(options.Timeout),
 | 
			
		||||
			client.WithDialTimeout(options.Timeout))
 | 
			
		||||
	}
 | 
			
		||||
	nctx := metadata.NewOutgoingContext(ctx, req.Header)
 | 
			
		||||
	err := options.Client.Call(nctx, options.Client.NewRequest(s.service, s.method, &codec.Frame{Data: req.Body}), rsp, copts...)
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		return nil, err
 | 
			
		||||
	}
 | 
			
		||||
	md, _ := metadata.FromOutgoingContext(nctx)
 | 
			
		||||
	return &Message{Header: md, Body: rsp.Data}, err
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
type microPublishStep struct {
 | 
			
		||||
	req    *Message
 | 
			
		||||
	rsp    *Message
 | 
			
		||||
	topic  string
 | 
			
		||||
	opts   StepOptions
 | 
			
		||||
	status Status
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microPublishStep) Request() *Message {
 | 
			
		||||
	return s.req
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microPublishStep) Response() *Message {
 | 
			
		||||
	return s.rsp
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microPublishStep) ID() string {
 | 
			
		||||
	return s.String()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microPublishStep) Options() StepOptions {
 | 
			
		||||
	return s.opts
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microPublishStep) Endpoint() string {
 | 
			
		||||
	return s.topic
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microPublishStep) Requires() []string {
 | 
			
		||||
	return s.opts.Requires
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microPublishStep) Require(steps ...Step) error {
 | 
			
		||||
	for _, step := range steps {
 | 
			
		||||
		s.opts.Requires = append(s.opts.Requires, step.String())
 | 
			
		||||
	}
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microPublishStep) String() string {
 | 
			
		||||
	if s.opts.ID != "" {
 | 
			
		||||
		return s.opts.ID
 | 
			
		||||
	}
 | 
			
		||||
	return s.topic
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microPublishStep) Name() string {
 | 
			
		||||
	return s.String()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microPublishStep) Hashcode() interface{} {
 | 
			
		||||
	return s.String()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microPublishStep) GetStatus() Status {
 | 
			
		||||
	return s.status
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microPublishStep) SetStatus(status Status) {
 | 
			
		||||
	s.status = status
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (s *microPublishStep) Execute(ctx context.Context, req *Message, opts ...ExecuteOption) (*Message, error) {
 | 
			
		||||
	return nil, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewCallStep create new step with client.Call
 | 
			
		||||
func NewCallStep(service string, name string, method string, opts ...StepOption) Step {
 | 
			
		||||
	options := NewStepOptions(opts...)
 | 
			
		||||
	return µCallStep{service: service, method: name + "." + method, opts: options}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewPublishStep create new step with client.Publish
 | 
			
		||||
func NewPublishStep(topic string, opts ...StepOption) Step {
 | 
			
		||||
	options := NewStepOptions(opts...)
 | 
			
		||||
	return µPublishStep{topic: topic, opts: options}
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										166
									
								
								flow/flow.go
									
									
									
									
									
								
							
							
						
						
									
										166
									
								
								flow/flow.go
									
									
									
									
									
								
							@@ -1,7 +1,163 @@
 | 
			
		||||
// Package flow is an interface used for saga pattern messaging
 | 
			
		||||
package flow
 | 
			
		||||
// Package flow is an interface used for saga pattern microservice workflow
 | 
			
		||||
package flow // import "go.unistack.org/micro/v4/flow"
 | 
			
		||||
 | 
			
		||||
type Step interface {
 | 
			
		||||
	// Endpoint returns service_name.service_method
 | 
			
		||||
	Endpoint() string
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"errors"
 | 
			
		||||
	"sync"
 | 
			
		||||
	"sync/atomic"
 | 
			
		||||
 | 
			
		||||
	"go.unistack.org/micro/v4/metadata"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
var (
 | 
			
		||||
	// ErrStepNotExists returns when step not found
 | 
			
		||||
	ErrStepNotExists = errors.New("step not exists")
 | 
			
		||||
	// ErrMissingClient returns when client.Client is missing
 | 
			
		||||
	ErrMissingClient = errors.New("client not set")
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// RawMessage is a raw encoded JSON value.
 | 
			
		||||
// It implements Marshaler and Unmarshaler and can be used to delay decoding or precompute a encoding.
 | 
			
		||||
type RawMessage []byte
 | 
			
		||||
 | 
			
		||||
// MarshalJSON returns m as the JSON encoding of m.
 | 
			
		||||
func (m *RawMessage) MarshalJSON() ([]byte, error) {
 | 
			
		||||
	if m == nil {
 | 
			
		||||
		return []byte("null"), nil
 | 
			
		||||
	}
 | 
			
		||||
	return *m, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// UnmarshalJSON sets *m to a copy of data.
 | 
			
		||||
func (m *RawMessage) UnmarshalJSON(data []byte) error {
 | 
			
		||||
	if m == nil {
 | 
			
		||||
		return errors.New("RawMessage UnmarshalJSON on nil pointer")
 | 
			
		||||
	}
 | 
			
		||||
	*m = append((*m)[0:0], data...)
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Message used to transfer data between steps
 | 
			
		||||
type Message struct {
 | 
			
		||||
	Header metadata.Metadata
 | 
			
		||||
	Body   RawMessage
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Step represents dedicated workflow step
 | 
			
		||||
type Step interface {
 | 
			
		||||
	// ID returns step id
 | 
			
		||||
	ID() string
 | 
			
		||||
	// Endpoint returns rpc endpoint service_name.service_method or broker topic
 | 
			
		||||
	Endpoint() string
 | 
			
		||||
	// Execute step run
 | 
			
		||||
	Execute(ctx context.Context, req *Message, opts ...ExecuteOption) (*Message, error)
 | 
			
		||||
	// Requires returns dependent steps
 | 
			
		||||
	Requires() []string
 | 
			
		||||
	// Options returns step options
 | 
			
		||||
	Options() StepOptions
 | 
			
		||||
	// Require add required steps
 | 
			
		||||
	Require(steps ...Step) error
 | 
			
		||||
	// String
 | 
			
		||||
	String() string
 | 
			
		||||
	// GetStatus returns step status
 | 
			
		||||
	GetStatus() Status
 | 
			
		||||
	// SetStatus sets the step status
 | 
			
		||||
	SetStatus(Status)
 | 
			
		||||
	// Request returns step request message
 | 
			
		||||
	Request() *Message
 | 
			
		||||
	// Response returns step response message
 | 
			
		||||
	Response() *Message
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Status contains step current status
 | 
			
		||||
type Status int
 | 
			
		||||
 | 
			
		||||
func (status Status) String() string {
 | 
			
		||||
	return StatusString[status]
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
const (
 | 
			
		||||
	// StatusPending step waiting to start
 | 
			
		||||
	StatusPending Status = iota
 | 
			
		||||
	// StatusRunning step is running
 | 
			
		||||
	StatusRunning
 | 
			
		||||
	// StatusFailure step competed with error
 | 
			
		||||
	StatusFailure
 | 
			
		||||
	// StatusSuccess step completed without error
 | 
			
		||||
	StatusSuccess
 | 
			
		||||
	// StatusAborted step aborted while it running
 | 
			
		||||
	StatusAborted
 | 
			
		||||
	// StatusSuspend step suspended
 | 
			
		||||
	StatusSuspend
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
var (
 | 
			
		||||
	// StatusString contains map status => string
 | 
			
		||||
	StatusString = map[Status]string{
 | 
			
		||||
		StatusPending: "StatusPending",
 | 
			
		||||
		StatusRunning: "StatusRunning",
 | 
			
		||||
		StatusFailure: "StatusFailure",
 | 
			
		||||
		StatusSuccess: "StatusSuccess",
 | 
			
		||||
		StatusAborted: "StatusAborted",
 | 
			
		||||
		StatusSuspend: "StatusSuspend",
 | 
			
		||||
	}
 | 
			
		||||
	// StringStatus contains map string => status
 | 
			
		||||
	StringStatus = map[string]Status{
 | 
			
		||||
		"StatusPending": StatusPending,
 | 
			
		||||
		"StatusRunning": StatusRunning,
 | 
			
		||||
		"StatusFailure": StatusFailure,
 | 
			
		||||
		"StatusSuccess": StatusSuccess,
 | 
			
		||||
		"StatusAborted": StatusAborted,
 | 
			
		||||
		"StatusSuspend": StatusSuspend,
 | 
			
		||||
	}
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Workflow contains all steps to execute
 | 
			
		||||
type Workflow interface {
 | 
			
		||||
	// ID returns id of the workflow
 | 
			
		||||
	ID() string
 | 
			
		||||
	// Execute workflow with args, return execution id and error
 | 
			
		||||
	Execute(ctx context.Context, req *Message, opts ...ExecuteOption) (string, error)
 | 
			
		||||
	// RemoveSteps remove steps from workflow
 | 
			
		||||
	RemoveSteps(steps ...Step) error
 | 
			
		||||
	// AppendSteps append steps to workflow
 | 
			
		||||
	AppendSteps(steps ...Step) error
 | 
			
		||||
	// Status returns workflow status
 | 
			
		||||
	Status() Status
 | 
			
		||||
	// Suspend suspends execution
 | 
			
		||||
	Suspend(ctx context.Context, id string) error
 | 
			
		||||
	// Resume resumes execution
 | 
			
		||||
	Resume(ctx context.Context, id string) error
 | 
			
		||||
	// Abort abort execution
 | 
			
		||||
	Abort(ctx context.Context, id string) error
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Flow the base interface to interact with workflows
 | 
			
		||||
type Flow interface {
 | 
			
		||||
	// Options returns options
 | 
			
		||||
	Options() Options
 | 
			
		||||
	// Init initialize
 | 
			
		||||
	Init(...Option) error
 | 
			
		||||
	// WorkflowCreate creates new workflow with specific id and steps
 | 
			
		||||
	WorkflowCreate(ctx context.Context, id string, steps ...Step) (Workflow, error)
 | 
			
		||||
	// WorkflowSave saves workflow
 | 
			
		||||
	WorkflowSave(ctx context.Context, w Workflow) error
 | 
			
		||||
	// WorkflowLoad loads workflow with specific id
 | 
			
		||||
	WorkflowLoad(ctx context.Context, id string) (Workflow, error)
 | 
			
		||||
	// WorkflowList lists all workflows
 | 
			
		||||
	WorkflowList(ctx context.Context) ([]Workflow, error)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
var (
 | 
			
		||||
	flowMu      sync.Mutex
 | 
			
		||||
	atomicSteps atomic.Value
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// RegisterStep register own step with workflow
 | 
			
		||||
func RegisterStep(step Step) {
 | 
			
		||||
	flowMu.Lock()
 | 
			
		||||
	steps, _ := atomicSteps.Load().([]Step)
 | 
			
		||||
	atomicSteps.Store(append(steps, step))
 | 
			
		||||
	flowMu.Unlock()
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
Some files were not shown because too many files have changed in this diff Show More
		Reference in New Issue
	
	Block a user