Compare commits
	
		
			555 Commits
		
	
	
		
			feature/ex
			...
			v0.0.609
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| f5d13ebe64 | |||
| 9730a91ad5 | |||
| 8c16e4d982 | |||
| 039a53a395 | |||
| 2cf571579b | |||
| 9a537bb8c2 | |||
| 78ad103151 | |||
| c764a946ff | |||
| ef59b1241f | |||
| a70ab33559 | |||
| a58bb4b14b | |||
| dc62bbe55f | |||
| b832d77d3e | |||
| 38467cb4e7 | |||
| 68b06158b3 | |||
| 5f51173276 | |||
| 1586314e3e | |||
| 254fe1556a | |||
| 52e74b59f5 | |||
| 64f2cd7219 | |||
| a29aec8fb5 | |||
| 8ea9b3f79f | |||
| a4b2a0589f | |||
| 4ef5f6059b | |||
| b23a444aa2 | |||
| 09932046f8 | |||
| 37e52595a2 | |||
| 95d7c90492 | |||
| 23a3235c7e | |||
| 506d276962 | |||
| 2a0cf84416 | |||
| 073aa84dd4 | |||
| a0dc9e92e4 | |||
| 98c591b019 | |||
| a93b93a3cd | |||
| 49bc52d63e | |||
| 959020e3c0 | |||
| 395e83acf6 | |||
| 55ff89f179 | |||
| cbaa283f74 | |||
| 20fb1f5601 | |||
| cc58639306 | |||
| cea822ffa6 | |||
| c20ae20cc1 | |||
| f07cd79b96 | |||
| 164c462b96 | |||
| 5e6cb63f14 | |||
| 4832aa9d6c | |||
| 4d606d3131 | |||
| be9b9e8ccf | |||
| 28cdfc5bd2 | |||
| 10a6627323 | |||
| 06b3b4116e | |||
| ff821390f7 | |||
| c8e9c34706 | |||
| b7c48cb467 | |||
| a0a80899f5 | |||
| 3543441b96 | |||
| eef12da4e6 | |||
| d009aafd4e | |||
| f7b4aa48d7 | |||
| 36b092774d | |||
| a8c6e39ac5 | |||
| 62f2ce9268 | |||
| 49375e90f0 | |||
| d8cf255c80 | |||
| b520282ba0 | |||
| 27cc9366b5 | |||
| d9517fe73c | |||
| 8a92a6cc52 | |||
| 9b2028ab54 | |||
| 207fd331d5 | |||
| 54b0d6701d | |||
| fc2657179b | |||
| d4894e31fe | |||
| 0ddfaf666b | |||
| e154137105 | |||
| 9b9a79b4ad | |||
| 5a8d7110e4 | |||
| d47c84cd47 | |||
| c571f3f888 | |||
| e884ba6b89 | |||
| 1a8e31e5ef | |||
| eccc0fe9e5 | |||
| c8dec24a0d | |||
| b8cb989e54 | |||
| ec672fbd49 | |||
| cfb0b53fc7 | |||
| a7389f44fa | |||
| 69f0fedd66 | |||
| 335ef4d8e8 | |||
| 61801ff20d | |||
| 361dca5c85 | |||
| 9f85a243e8 | |||
| dc6cb274ee | |||
| f6b47792a4 | |||
| 295b3ef793 | |||
| 721c176337 | |||
| ebba6545a3 | |||
| 19c7e22ced | |||
| 9f883b458f | |||
| 1f456c5134 | |||
| d7fbef37db | |||
| a1668b6e5a | |||
| 3a17edfaf0 | |||
| 3320a9c19d | |||
| 8dcd8a270a | |||
| 03a9b276d8 | |||
| 9c8cde384f | |||
| 99b000ecf4 | |||
| a173e30090 | |||
| a3481a7d2d | |||
| a8e6f98a89 | |||
| ab805403b9 | |||
| 1e98d351ce | |||
| c40bdc8e9e | |||
| 7204562879 | |||
| 741611a2e1 | |||
| 133aeb8374 | |||
| b78a468632 | |||
| f1b4480e0f | |||
| ffffe4bf24 | |||
| 413bf3c848 | |||
| 646990b549 | |||
| e5818146a8 | |||
| 1310054121 | |||
| 49d423915c | |||
| 1962cb3c52 | |||
| 84f124dd4d | |||
| ff8e066135 | |||
| bc5c61e43d | |||
| 6ded615723 | |||
| abc8af525a | |||
| 19d943361b | |||
| b464afae01 | |||
| 56bc5e8285 | |||
| cb95bb561c | |||
| dff8941bd3 | |||
| 78e1c33e30 | |||
| d2f2a0558a | |||
| fc4bed4b9f | |||
|   | 94a7bf250d | ||
| f6121a6961 | |||
| 7fc73f1e93 | |||
| 2504ef00a0 | |||
| fc5803493c | |||
| a9295bfabf | |||
| 12fa53d848 | |||
| d2bb362135 | |||
| 9dd81f6bd5 | |||
| d2c04afcd5 | |||
| 62980e1489 | |||
| 59963adf74 | |||
| 194ea4ace5 | |||
| 73b80a66bc | |||
| d8b2d01274 | |||
| bfa8457e95 | |||
| 70106733d9 | |||
| ce7837b9ef | |||
| d0d72167eb | |||
| a55ee1a6ce | |||
| dfc319573c | |||
| 246e555f3f | |||
| c28bc086b2 | |||
| d44e971325 | |||
| fe4cdc48af | |||
| 631006a4e1 | |||
| 567ead8697 | |||
| e4886b4a7d | |||
| dcb5d3d7cd | |||
| 15a639f85a | |||
| 303bd04649 | |||
| 7bda674939 | |||
| 126d4fbd0b | |||
| fed8bccaab | |||
| 47b6a6b508 | |||
| 764ce79a71 | |||
| b876c64ba2 | |||
| 8d52b41f57 | |||
| f47e2a33fe | |||
| 9321938dad | |||
| 3828d601a2 | |||
| 2e713c808d | |||
| 6602f86b43 | |||
| 24d9f0fdc7 | |||
| 8446b2da22 | |||
| 758e5a67b5 | |||
| 678ddd7124 | |||
| 36b71dfaf3 | |||
| 9491b72b8d | |||
| 6c4af4006b | |||
| 8bf3a337cf | |||
| 16146494dc | |||
| b0e443ad99 | |||
| 9955eacf96 | |||
| f0347a9435 | |||
| 7c869c65f3 | |||
| 14f39a9162 | |||
| dcd106c1cd | |||
| b704e2a362 | |||
| 6b4bd5a6f8 | |||
| 6df4f5f2a1 | |||
| 780905ba35 | |||
| c679797765 | |||
| 401aad9fa4 | |||
| 645113d553 | |||
| 4a33986b6a | |||
| c1c8c64c76 | |||
| 0927fdc4d7 | |||
| 102a280dda | |||
| f13384d794 | |||
| 409d6e108d | |||
| ed53f297bd | |||
| 42424f4bc2 | |||
| 9e5b8c5277 | |||
| 9abe28c490 | |||
| 422bbd8593 | |||
| 3956675e04 | |||
| 10c3780b52 | |||
| 8edc067a3b | |||
| 1007f2c834 | |||
| c25da03217 | |||
| 4b55dbaacf | |||
| c399fa42ae | |||
| 9e586f7706 | |||
| 3cc8dccc63 | |||
| 7fedfbca81 | |||
| 3c439ba428 | |||
| ad24f6db44 | |||
| 1869ff3d75 | |||
| 30ce8c4b60 | |||
| 885bb53244 | |||
| 1c7dc1820a | |||
| 7e16e799e4 | |||
| 890e16241d | |||
| b9d0348735 | |||
| b9e9575b9b | |||
| 295a098eb4 | |||
| b69a082bb1 | |||
| a4a8c83d17 | |||
| e952176bb0 | |||
| d99adb203b | |||
| f1f91f4cfa | |||
| 2afb265ea4 | |||
| be24f7a190 | |||
| aae8a706e9 | |||
| 7d64f18f54 | |||
| d08b2e565a | |||
| d29e84894d | |||
| 617298c366 | |||
| 668f308565 | |||
| 240a8ed7aa | |||
| 70de8e8d04 | |||
| d38fa60fbc | |||
| 5fba7e0e2f | |||
| 8757643399 | |||
| 42bd4cf58d | |||
| 413178e2d3 | |||
| 9264a2e99b | |||
| 2a0471fb3d | |||
| 1497c013f9 | |||
| ef78b7467b | |||
| 0eda32b725 | |||
| f9ccafb976 | |||
| 6e90239fef | |||
| 05580c384a | |||
| 3188b951fb | |||
| 6b211d1443 | |||
| b2b9b40792 | |||
| 2f915cb6c1 | |||
| b2b93f570a | |||
| 8247fc4524 | |||
| 5dad44ad09 | |||
| f042183433 | |||
| b0be93a7a0 | |||
| 1c143921e6 | |||
| 68e63a9cf6 | |||
| c3162fec95 | |||
| 1124aa781a | |||
| eef0e9f2aa | |||
| af38b06d22 | |||
| 2fad6340c7 | |||
| 03aa0a2282 | |||
| 358c238f3d | |||
| d65ac8ba2b | |||
| 55d02b8c65 | |||
| 8a3965f666 | |||
| 4aa2f494b1 | |||
| 8f13eb2f16 | |||
| 8f15d42173 | |||
| 07fa21dcca | |||
| e657de7f78 | |||
| c534e998e8 | |||
| 88642770c5 | |||
| 8528b5cb66 | |||
| 5ba84bd8ee | |||
| 1260b2dc77 | |||
| 7d18b913c6 | |||
| d1f9069f2f | |||
| fa6d73301e | |||
| bfe62799d3 | |||
| ede912eb7b | |||
| ff8f128fe8 | |||
| 1971f1396f | |||
| bf6c184d12 | |||
| 770f5c5c64 | |||
| 623c021689 | |||
| afcc89bf9e | |||
| 1672e8f8fd | |||
| 398ed56d32 | |||
| f3ecba3883 | |||
| 45031b05cf | |||
| 7413ea045d | |||
| 62c9a4e734 | |||
| 3a8baaa6d9 | |||
| 498785e213 | |||
| 678f95642c | |||
| dacc97e2ce | |||
| f8c0c0afa0 | |||
| 2fbd5cf965 | |||
| 75f71fe3db | |||
| ab1a1ab6f6 | |||
| 19ee5019ef | |||
| 42b68507f2 | |||
| 9d0047a11e | |||
| 06d81f1682 | |||
| 7b8ab03779 | |||
| 07cbcf5a0a | |||
| da41ec3e84 | |||
| 592fae25af | |||
| 7968460fa2 | |||
| b808c5727c | |||
| 796f7956b8 | |||
| 1e6b92d1d9 | |||
| 0b85fa5af9 | |||
| c3318cc1de | |||
| fbf4d7b915 | |||
| 9cc0abf9e0 | |||
| 7c40bcfd3c | |||
| 05636a1e4d | |||
| 0f52b860ea | |||
| b5cd116219 | |||
| 98486842ae | |||
| 7577a2dd47 | |||
| 08681756b6 | |||
| 64772d0474 | |||
| 127764556e | |||
| 170f43d806 | |||
| 9dffc41274 | |||
| c63cf442f8 | |||
| a2ba283632 | |||
| 4a1fb1ae18 | |||
| a127b24e62 | |||
| 69d6290376 | |||
| c08a739158 | |||
| 5f5f0e44f0 | |||
| 6e6797eac5 | |||
| cd9406900a | |||
| 6c81f7f6bc | |||
| d56a0235af | |||
| de2ca763c1 | |||
| da52bb5c90 | |||
| 3d4afe7b25 | |||
| f5766d639c | |||
| cdf2a6e76b | |||
| 6d7cfb86f8 | |||
| 1e9d663ffe | |||
| 5b8d7ebf87 | |||
| 11dc6d2640 | |||
| 29a3f73f15 | |||
| 98105642fc | |||
| 0fd5f3b417 | |||
| 43cac4b3bb | |||
| cd68af8e66 | |||
| 113d838876 | |||
| 9e5bc0d3ea | |||
| 6d3bd13f61 | |||
| b5ca475b3f | |||
| a75b1291cb | |||
| 21cd1ee066 | |||
| ae43cbb623 | |||
| 9b752a911c | |||
| ec9ac26a4c | |||
| 39a0b73d56 | |||
| 2e2e15d4d2 | |||
| 0d16946aba | |||
| 14441c2378 | |||
| f6bcdc9903 | |||
| a95053211c | |||
| 813ce71e3e | |||
| 56ae0cfc6c | |||
| 202afc9068 | |||
| 56094b3cb6 | |||
| 0da098e9f9 | |||
| f0881c9fd6 | |||
| 029b408749 | |||
| 84b2be3169 | |||
| c872cecc67 | |||
| 99cd92729e | |||
| ac416f7b69 | |||
| e10140e143 | |||
| e165f0f62f | |||
| 655d4daad9 | |||
| 87a004e577 | |||
| 376c6cab50 | |||
| 4a3f25baa0 | |||
| aa33bc8df3 | |||
| 96b3718375 | |||
| 5f9b55933b | |||
| 74d42637e7 | |||
| 0c05bcf29b | |||
| 9136143f2f | |||
| 2f1b784dc2 | |||
| 190584e0e6 | |||
| b7003b9ec9 | |||
| 4f871271e8 | |||
| 91f4793678 | |||
| 3b30bb049e | |||
| f0c5b36ea9 | |||
| 647ec64c3b | |||
| b5f9b6b638 | |||
| c7949febf2 | |||
| 15a4b2a713 | |||
| 493c6ebae8 | |||
| fb847b03af | |||
| f826633e6e | |||
| edeae23bf1 | |||
| a038b86147 | |||
| ede0b99d3a | |||
| d04ce18eb0 | |||
| 8ae9a0f107 | |||
| a259bb6dbc | |||
| adf32568ee | |||
| 0cfa159cb1 | |||
| 0ead99608a | |||
| 7fe3e66cad | |||
| a73d7d1654 | |||
| bbd7a7bc2c | |||
| f5151eb214 | |||
| eefb9ac9f5 | |||
| 468a7d212d | |||
| a4def75d06 | |||
| 16c66ee28c | |||
| 2e6ca48d22 | |||
| b1d6509294 | |||
| e909d656d9 | |||
| 0971f60c30 | |||
| d8270e53ed | |||
| 1ee127937a | |||
| 56684b2c0b | |||
| 1ea6695f82 | |||
| 5273ff7600 | |||
| caa69c3629 | |||
| 0ff5f0aa28 | |||
| d5cb1e48ed | |||
| 1c2d3f541f | |||
| ec62ad436f | |||
| 8d0ef0f002 | |||
| d78550672e | |||
| 1d629f6db8 | |||
| f7d291056d | |||
| 710c257c64 | |||
| c320bb3d90 | |||
| 2f01a1d50f | |||
| ffc57b7e89 | |||
| d88cd3c22b | |||
| ac5ad640bd | |||
| 21d241f9b1 | |||
| 2569c165f8 | |||
| ee262a94fb | |||
| 7977c0e59c | |||
| ceff0161c6 | |||
| a30da61419 | |||
| b613b122e3 | |||
| d017530444 | |||
| 8de83cc290 | |||
| 603ec82b83 | |||
| 93c4cf31a8 | |||
| dc2d8a9103 | |||
| 6589e8d5cd | |||
| 0006c6859d | |||
| 827b3fc1b7 | |||
| f7dce4a102 | |||
| 45d4fd7101 | |||
| c7df9d2264 | |||
| d0954bf133 | |||
| 8affa81bb9 | |||
| fe9ebf0bab | |||
| a4b5f33d15 | |||
| e89e2c18f2 | |||
| b16d5152c7 | |||
| 5fb2f8a312 | |||
| 2ad820be8d | |||
| 555096102a | |||
| d76d7b5cb9 | |||
| 6622c9003d | |||
| b02e1d2e85 | |||
| c338d23070 | |||
| 1fbae343a4 | |||
| 31418bf0e6 | |||
| 6d45f6f667 | |||
| f610a2202c | |||
| 2807299d46 | |||
| e872dbccec | |||
| 9daf71e2ed | |||
| fe278f7772 | |||
| 8ebda6fb3a | |||
| b0d3ce8c1c | |||
| 021465e524 | |||
| cf9c73aa4a | |||
| 0652bf22dc | |||
| b196adffc7 | |||
| 717065e62d | |||
| e7b2b040b2 | |||
| 05d0f9e469 | |||
| ccd03e50c8 | |||
| 1c77c2b8e8 | |||
| 9f6f967299 | |||
| 18c83f0f76 | |||
| a64f336e24 | |||
| 14bbd205f8 | |||
| cecfb0d788 | |||
| a445e6f623 | |||
| 0aa6310971 | |||
| 2f66ab1cf0 | |||
| 304e779470 | |||
| 5e295d65c5 | |||
| ef3705937c | |||
| d780c7965f | |||
| c13db6802e | |||
| c5e23ab451 | |||
| c266d9204b | |||
| 2550691e2e | |||
| ca24e1d5bf | |||
| b156052e6f | |||
| dda2418255 | |||
| 8e40deae6a | |||
| 289b9f47a2 | |||
| 007c44df85 | |||
| a6252f0743 | |||
| 86c01659d7 | |||
| 62acddda5e | |||
| ee325f67fd | |||
| dba0cd229e | |||
| ec4dba173f | |||
| 22ce2d26f3 | |||
| 4fd768e573 | |||
| bf16a8165f | |||
| 9f5612248a | |||
| 4a2b830252 | |||
| c492c80881 | |||
| 26dd16d021 | |||
| b0b43de8ca | |||
| 94f72e4ddf | |||
| df4388e6dc | 
							
								
								
									
										55
									
								
								.gitea/workflows/tests.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										55
									
								
								.gitea/workflows/tests.yml
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,55 @@ | |||||||
|  |  | ||||||
|  | # https://docs.gitea.com/next/usage/actions/quickstart | ||||||
|  | # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions | ||||||
|  | # https://docs.github.com/en/actions/learn-github-actions/contexts#github-context | ||||||
|  |  | ||||||
|  | name: Build Docker and Deploy | ||||||
|  | run-name: Build & Deploy ${{ gitea.ref }} on ${{ gitea.actor }} | ||||||
|  |  | ||||||
|  | on: | ||||||
|  |   push: | ||||||
|  |     branches: | ||||||
|  |       - '*' | ||||||
|  |       - '**' | ||||||
|  |  | ||||||
|  |  | ||||||
|  | jobs: | ||||||
|  |   run_tests: | ||||||
|  |     name: Run goext test-suite   | ||||||
|  |     runs-on: bfb-cicd-latest | ||||||
|  |     steps: | ||||||
|  |  | ||||||
|  |       - name: Check out code | ||||||
|  |         uses: actions/checkout@v3 | ||||||
|  |  | ||||||
|  |       - name: Setup go | ||||||
|  |         uses: actions/setup-go@v4 | ||||||
|  |         with: | ||||||
|  |           go-version-file: '${{ gitea.workspace }}/go.mod' | ||||||
|  |  | ||||||
|  |       - name: Setup packages | ||||||
|  |         uses: awalsh128/cache-apt-pkgs-action@latest | ||||||
|  |         with: | ||||||
|  |           packages: curl python3 | ||||||
|  |           version: 1.0 | ||||||
|  |  | ||||||
|  |       - name: go version | ||||||
|  |         run: go version | ||||||
|  |  | ||||||
|  |       - name: Run tests | ||||||
|  |         run: cd "${{ gitea.workspace }}" && make test | ||||||
|  |  | ||||||
|  |       - name: Send failure mail | ||||||
|  |         if: failure() | ||||||
|  |         uses: dawidd6/action-send-mail@v3 | ||||||
|  |         with: | ||||||
|  |           server_address: smtp.fastmail.com | ||||||
|  |           server_port: 465 | ||||||
|  |           secure: true | ||||||
|  |           username: ${{secrets.MAIL_USERNAME}} | ||||||
|  |           password: ${{secrets.MAIL_PASSWORD}} | ||||||
|  |           subject: Pipeline on '${{ gitea.repository }}' failed | ||||||
|  |           to: ${{ steps.commiter_info.outputs.MAIL }} | ||||||
|  |           from: Gitea Actions <gitea_actions@blackforestbytes.de> | ||||||
|  |           body: "Go to https://gogs.blackforestbytes.com/${{ gitea.repository }}/actions" | ||||||
|  |  | ||||||
							
								
								
									
										2
									
								
								.idea/.gitignore
									
									
									
										generated
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								.idea/.gitignore
									
									
									
										generated
									
									
										vendored
									
									
								
							| @@ -6,3 +6,5 @@ | |||||||
| # Datasource local storage ignored files | # Datasource local storage ignored files | ||||||
| /dataSources/ | /dataSources/ | ||||||
| /dataSources.local.xml | /dataSources.local.xml | ||||||
|  | # GitHub Copilot persisted chat sessions | ||||||
|  | /copilot/chatSessions | ||||||
|   | |||||||
							
								
								
									
										6
									
								
								.idea/copilot.data.migration.agent.xml
									
									
									
										generated
									
									
									
										Normal file
									
								
							
							
						
						
									
										6
									
								
								.idea/copilot.data.migration.agent.xml
									
									
									
										generated
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,6 @@ | |||||||
|  | <?xml version="1.0" encoding="UTF-8"?> | ||||||
|  | <project version="4"> | ||||||
|  |   <component name="AgentMigrationStateService"> | ||||||
|  |     <option name="migrationStatus" value="COMPLETED" /> | ||||||
|  |   </component> | ||||||
|  | </project> | ||||||
							
								
								
									
										6
									
								
								.idea/copilot.data.migration.ask.xml
									
									
									
										generated
									
									
									
										Normal file
									
								
							
							
						
						
									
										6
									
								
								.idea/copilot.data.migration.ask.xml
									
									
									
										generated
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,6 @@ | |||||||
|  | <?xml version="1.0" encoding="UTF-8"?> | ||||||
|  | <project version="4"> | ||||||
|  |   <component name="AskMigrationStateService"> | ||||||
|  |     <option name="migrationStatus" value="COMPLETED" /> | ||||||
|  |   </component> | ||||||
|  | </project> | ||||||
							
								
								
									
										6
									
								
								.idea/copilot.data.migration.ask2agent.xml
									
									
									
										generated
									
									
									
										Normal file
									
								
							
							
						
						
									
										6
									
								
								.idea/copilot.data.migration.ask2agent.xml
									
									
									
										generated
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,6 @@ | |||||||
|  | <?xml version="1.0" encoding="UTF-8"?> | ||||||
|  | <project version="4"> | ||||||
|  |   <component name="Ask2AgentMigrationStateService"> | ||||||
|  |     <option name="migrationStatus" value="COMPLETED" /> | ||||||
|  |   </component> | ||||||
|  | </project> | ||||||
							
								
								
									
										6
									
								
								.idea/copilot.data.migration.edit.xml
									
									
									
										generated
									
									
									
										Normal file
									
								
							
							
						
						
									
										6
									
								
								.idea/copilot.data.migration.edit.xml
									
									
									
										generated
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,6 @@ | |||||||
|  | <?xml version="1.0" encoding="UTF-8"?> | ||||||
|  | <project version="4"> | ||||||
|  |   <component name="EditMigrationStateService"> | ||||||
|  |     <option name="migrationStatus" value="COMPLETED" /> | ||||||
|  |   </component> | ||||||
|  | </project> | ||||||
							
								
								
									
										6
									
								
								.idea/goext.iml
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										6
									
								
								.idea/goext.iml
									
									
									
										generated
									
									
									
								
							| @@ -1,6 +1,10 @@ | |||||||
| <?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||||||
| <module type="WEB_MODULE" version="4"> | <module type="WEB_MODULE" version="4"> | ||||||
|   <component name="Go" enabled="true" /> |   <component name="Go" enabled="true"> | ||||||
|  |     <buildTags> | ||||||
|  |       <option name="goVersion" value="1.19" /> | ||||||
|  |     </buildTags> | ||||||
|  |   </component> | ||||||
|   <component name="NewModuleRootManager"> |   <component name="NewModuleRootManager"> | ||||||
|     <content url="file://$MODULE_DIR$" /> |     <content url="file://$MODULE_DIR$" /> | ||||||
|     <orderEntry type="inheritedJdk" /> |     <orderEntry type="inheritedJdk" /> | ||||||
|   | |||||||
							
								
								
									
										6
									
								
								.idea/golinter.xml
									
									
									
										generated
									
									
									
										Normal file
									
								
							
							
						
						
									
										6
									
								
								.idea/golinter.xml
									
									
									
										generated
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,6 @@ | |||||||
|  | <?xml version="1.0" encoding="UTF-8"?> | ||||||
|  | <project version="4"> | ||||||
|  |   <component name="GoLinterSettings"> | ||||||
|  |     <option name="checkGoLinterExe" value="false" /> | ||||||
|  |   </component> | ||||||
|  | </project> | ||||||
							
								
								
									
										6
									
								
								.idea/sqldialects.xml
									
									
									
										generated
									
									
									
										Normal file
									
								
							
							
						
						
									
										6
									
								
								.idea/sqldialects.xml
									
									
									
										generated
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,6 @@ | |||||||
|  | <?xml version="1.0" encoding="UTF-8"?> | ||||||
|  | <project version="4"> | ||||||
|  |   <component name="SqlDialectMappings"> | ||||||
|  |     <file url="file://$PROJECT_DIR$/sq/sq_test.go" dialect="SQLite" /> | ||||||
|  |   </component> | ||||||
|  | </project> | ||||||
							
								
								
									
										10
									
								
								Makefile
									
									
									
									
									
								
							
							
						
						
									
										10
									
								
								Makefile
									
									
									
									
									
								
							| @@ -3,7 +3,15 @@ run: | |||||||
| 	echo "This is a library - can't be run" && false | 	echo "This is a library - can't be run" && false | ||||||
|  |  | ||||||
| test: | test: | ||||||
| 	go test ./... | 	# go test ./... | ||||||
|  | 	which gotestsum || go install gotest.tools/gotestsum@latest | ||||||
|  | 	gotestsum --format "testname" -- -tags="timetzdata sqlite_fts5 sqlite_foreign_keys" "./..." | ||||||
|  |  | ||||||
|  | test-in-docker: | ||||||
|  | 	tag="goext_temp_test_image:$(shell uuidgen | tr -d '-')";        \ | ||||||
|  | 	docker build --tag $$tag . -f .gitea/workflows/Dockerfile_tests; \ | ||||||
|  | 	docker run --rm $$tag;                                           \ | ||||||
|  | 	docker rmi $$tag | ||||||
|  |  | ||||||
| version: | version: | ||||||
| 	_data/version.sh | 	_data/version.sh | ||||||
							
								
								
									
										105
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										105
									
								
								README.md
									
									
									
									
									
								
							| @@ -5,4 +5,107 @@ A collection of general & useful library methods | |||||||
|  |  | ||||||
| This should not have any heavy dependencies (gin, mongo, etc) and add missing basic language features... | This should not have any heavy dependencies (gin, mongo, etc) and add missing basic language features... | ||||||
|  |  | ||||||
| Potentially needs `export GOPRIVATE="gogs.mikescher.com"` | Potentially needs `export GOPRIVATE="git.blackforestbytes.com"` | ||||||
|  |  | ||||||
|  |  | ||||||
|  | ## Packages: | ||||||
|  |  | ||||||
|  | | Name        | Maintainer | Description                                                                                                   | | ||||||
|  | |-------------|------------|---------------------------------------------------------------------------------------------------------------| | ||||||
|  | | langext     | Mike       | General uttility/helper functions, (everything thats missing from go standard library)                        | | ||||||
|  | | mathext     | Mike       | Utility/Helper functions for math                                                                             | | ||||||
|  | | cryptext    | Mike       | Utility/Helper functions for encryption                                                                       | | ||||||
|  | | syncext     | Mike       | Utility/Helper funtions for multi-threading / mutex / channels                                                | | ||||||
|  | | dataext     | Mike       | Various useful data structures                                                                                | | ||||||
|  | | zipext      | Mike       | Utility for zip/gzip/tar etc                                                                                  | | ||||||
|  | | reflectext  | Mike       | Utility for golang reflection                                                                                 | | ||||||
|  | | fsext       | Mike       | Utility for filesytem access                                                                                  | | ||||||
|  | | ctxext      | Mike       | Utility for context.Context                                                                                   | | ||||||
|  | |             |            |                                                                                                               | | ||||||
|  | | mongoext    | Mike       | Utility/Helper functions for mongodb (kinda abandoned)                                                        | | ||||||
|  | | cursortoken | Mike       | MongoDB cursortoken implementation                                                                            | | ||||||
|  | | pagination  | Mike       | Pagination implementation                                                                                     | | ||||||
|  | |             |            |                                                                                                               | | ||||||
|  | | totpext     | Mike       | Implementation of TOTP (2-Factor-Auth)                                                                        | | ||||||
|  | | termext     | Mike       | Utilities for terminals (mostly color output)                                                                 | | ||||||
|  | | confext     | Mike       | Parses environment configuration into structs                                                                 | | ||||||
|  | | cmdext      | Mike       | Runner for external commands/processes                                                                        | | ||||||
|  | |             |            |                                                                                                               | | ||||||
|  | | sq          | Mike       | Utility functions for sql based databases (primarily sqlite)                                                  | | ||||||
|  | | tst         | Mike       | Utility functions for unit tests                                                                              | | ||||||
|  | |             |            |                                                                                                               | | ||||||
|  | | rfctime     | Mike       | Classes for time seriallization, with different marshallign method for mongo and json                         | | ||||||
|  | | gojson      | Mike       | Same interface for marshalling/unmarshalling as go/json, except with proper serialization of null arrays/maps | | ||||||
|  | |             |            |                                                                                                               | | ||||||
|  | | bfcodegen   | Mike       | Various codegen tools (run via go generate)                                                                   | | ||||||
|  | |             |            |                                                                                                               | | ||||||
|  | | rext        | Mike       | Regex Wrapper, wraps regexp with a better interface                                                           | | ||||||
|  | | wmo         | Mike       | Mongo Wrapper, wraps mongodb with a better interface                                                          | | ||||||
|  | |             |            |                                                                                                               | | ||||||
|  | | scn         | Mike       | SimpleCloudNotifier                                                                                           | | ||||||
|  | |             |            |                                                                                                               | | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  | ## Usage: | ||||||
|  |  | ||||||
|  | ### exerr | ||||||
|  |  | ||||||
|  |  - see **mongoext/builder.go** for full info | ||||||
|  |  | ||||||
|  | Short summary: | ||||||
|  |  - An better error package with metadata, listener, api-output and error-traces | ||||||
|  |  - Initialize with `exerr.Init()` | ||||||
|  |  - *Never* return `err` direct, always use exerr.Wrap(err, "...") - add metadata where applicable | ||||||
|  |  - at the end either Print(), Fatal() or Output() your error (print = stdout, fatal = panic, output = json API response) | ||||||
|  |  - You can add listeners with exerr.RegisterListener(), and save the full errors to a db or smth | ||||||
|  |  | ||||||
|  | ### wmo | ||||||
|  |  | ||||||
|  |  - A typed wrapper around the official mongo-go-driver | ||||||
|  |  - Use `wmo.W[...](...)` to wrap the collections and type-ify them | ||||||
|  |  - The new collections have all the usual methods, but types | ||||||
|  |  - Also they have List() and Paginate() methods for paginated listings (witehr with a cursortoken or page/limit) | ||||||
|  |  - Register additional hooks with `WithDecodeFunc`, `WithUnmarshalHook`, `WithMarshalHook`, `WithModifyingPipeline`, `WithModifyingPipelineFunc` | ||||||
|  |  - List(), Paginate(), etc support filter interfaces | ||||||
|  |    - Rule(s) of thumb:  | ||||||
|  |      - filter the results in the filter interface | ||||||
|  |      - sort the results in the sort function of the filter interface | ||||||
|  |      - add joins ($lookup's) in the `WithModifyingPipelineFunc`/`WithModifyingPipeline` | ||||||
|  |  | ||||||
|  | #### ginext | ||||||
|  |  | ||||||
|  |  - A wrapper around gin-gonic/gin | ||||||
|  |  - create the gin engine with `ginext.NewEngine` | ||||||
|  |  - Add routes with `engine.Routes()...` | ||||||
|  |    - `.Use(..)` adds a middleware | ||||||
|  |    - `.Group(..)` adds a group | ||||||
|  |    - `.Get().Handle(..)` adds a handler | ||||||
|  |  - Handler return values (in contract to ginext) - values implement the `ginext.HTTPResponse` interface | ||||||
|  |  - Every handler starts with something like: | ||||||
|  | ```go  | ||||||
|  | func (handler Handler) CommunityMetricsValues(pctx ginext.PreContext) ginext.HTTPResponse { | ||||||
|  |     type communityURI struct { | ||||||
|  |         Version     string             `uri:"version"` | ||||||
|  |         CommunityID models.CommunityID `uri:"cid"` | ||||||
|  |     } | ||||||
|  |     type body struct { | ||||||
|  |         UserID  models.UserID  `json:"userID"` | ||||||
|  |         EventID models.EventID `json:"eventID"` | ||||||
|  |     } | ||||||
|  |  | ||||||
|  |     var u uri | ||||||
|  |     var b body | ||||||
|  |     ctx, gctx, httpErr := pctx.URI(&u).Body(&b).Start() // can have more unmarshaller, like header, form, etc | ||||||
|  |     if httpErr != nil { | ||||||
|  |     	return *httpErr | ||||||
|  |     } | ||||||
|  |     defer ctx.Cancel() | ||||||
|  |  | ||||||
|  |     // do stuff | ||||||
|  | } | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | #### sq | ||||||
|  |  | ||||||
|  |  - TODO (like mongoext for sqlite/sql databases) | ||||||
							
								
								
									
										9
									
								
								TODO.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										9
									
								
								TODO.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,9 @@ | |||||||
|  |  | ||||||
|  |  | ||||||
|  |  - cronext | ||||||
|  |  | ||||||
|  |  - rfctime.HMSTimeOnly | ||||||
|  |  - rfctime.NanoTimeOnly | ||||||
|  |  | ||||||
|  |  - remove sqlx dependency from sq  (unmaintained, and mostly superseeded by our own stuff?) | ||||||
|  |  - Move DBLogger and DBPreprocessor to sq | ||||||
| @@ -7,6 +7,29 @@ set -o pipefail  # Return value of a pipeline is the value of the last (rightmos | |||||||
| IFS=$'\n\t'      # Set $IFS to only newline and tab. | IFS=$'\n\t'      # Set $IFS to only newline and tab. | ||||||
|  |  | ||||||
|  |  | ||||||
|  | function black() { echo -e "\x1B[30m $1 \x1B[0m"; } | ||||||
|  | function red()   { echo -e "\x1B[31m $1 \x1B[0m"; } | ||||||
|  | function green() { echo -e "\x1B[32m $1 \x1B[0m"; } | ||||||
|  | function yellow(){ echo -e "\x1B[33m $1 \x1B[0m"; } | ||||||
|  | function blue()  { echo -e "\x1B[34m $1 \x1B[0m"; } | ||||||
|  | function purple(){ echo -e "\x1B[35m $1 \x1B[0m"; } | ||||||
|  | function cyan()  { echo -e "\x1B[36m $1 \x1B[0m"; } | ||||||
|  | function white() { echo -e "\x1B[37m $1 \x1B[0m"; } | ||||||
|  |  | ||||||
|  | if [ "$( git rev-parse --abbrev-ref HEAD )" != "master" ]; then | ||||||
|  |   >&2 red "[ERROR] Can only create versions of <master>" | ||||||
|  |   exit 1 | ||||||
|  | fi | ||||||
|  |  | ||||||
|  | echo "" | ||||||
|  | echo -n "Insert optional commit message: " | ||||||
|  | read commitMessage | ||||||
|  | echo "" | ||||||
|  |  | ||||||
|  | git pull --ff | ||||||
|  |  | ||||||
|  | go get -u ./... | ||||||
|  |  | ||||||
| curr_vers=$(git describe --tags --abbrev=0 | sed 's/v//g') | curr_vers=$(git describe --tags --abbrev=0 | sed 's/v//g') | ||||||
|  |  | ||||||
| next_ver=$(echo "$curr_vers" | awk -F. -v OFS=. 'NF==1{print ++$NF}; NF>1{if(length($NF+1)>length($NF))$(NF-1)++; $NF=sprintf("%0*d", length($NF), ($NF+1)%(10^length($NF))); print}') | next_ver=$(echo "$curr_vers" | awk -F. -v OFS=. 'NF==1{print ++$NF}; NF>1{if(length($NF+1)>length($NF))$(NF-1)++; $NF=sprintf("%0*d", length($NF), ($NF+1)%(10^length($NF))); print}') | ||||||
| @@ -16,9 +39,22 @@ echo "> Current Version: ${curr_vers}" | |||||||
| echo "> Next    Version: ${next_ver}" | echo "> Next    Version: ${next_ver}" | ||||||
| echo "" | echo "" | ||||||
|  |  | ||||||
|  | printf "package goext\n\nconst GoextVersion = \"%s\"\n\nconst GoextVersionTimestamp = \"%s\"\n" "${next_ver}" "$( date +"%Y-%m-%dT%H:%M:%S%z" )" > "goextVersion.go" | ||||||
|  |  | ||||||
| git add --verbose . | git add --verbose . | ||||||
|  |  | ||||||
| git commit -a -m "v${next_ver}" | msg="v${next_ver}" | ||||||
|  |  | ||||||
|  | if [[ "$commitMessage" != "" ]]; then | ||||||
|  |   msg="${msg} ${commitMessage}" | ||||||
|  | fi | ||||||
|  |  | ||||||
|  |  | ||||||
|  | if [ $# -gt 0 ]; then | ||||||
|  |   msg="$1" | ||||||
|  | fi | ||||||
|  |  | ||||||
|  | git commit -a -m "${msg}" | ||||||
|  |  | ||||||
| git tag "v${next_ver}" | git tag "v${next_ver}" | ||||||
|  |  | ||||||
|   | |||||||
							
								
								
									
										
											BIN
										
									
								
								bfcodegen/_test_example_1.tgz
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								bfcodegen/_test_example_1.tgz
									
									
									
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								bfcodegen/_test_example_2.tgz
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								bfcodegen/_test_example_2.tgz
									
									
									
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										197
									
								
								bfcodegen/csid-generate.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										197
									
								
								bfcodegen/csid-generate.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,197 @@ | |||||||
|  | package bfcodegen | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"bytes" | ||||||
|  | 	_ "embed" | ||||||
|  | 	"errors" | ||||||
|  | 	"fmt" | ||||||
|  | 	"go/format" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/cryptext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/rext" | ||||||
|  | 	"io" | ||||||
|  | 	"os" | ||||||
|  | 	"path" | ||||||
|  | 	"path/filepath" | ||||||
|  | 	"regexp" | ||||||
|  | 	"strings" | ||||||
|  | 	"text/template" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | type CSIDDef struct { | ||||||
|  | 	File         string | ||||||
|  | 	FileRelative string | ||||||
|  | 	Name         string | ||||||
|  | 	Prefix       string | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type CSIDGenOptions struct { | ||||||
|  | 	DebugOutput *bool | ||||||
|  | } | ||||||
|  |  | ||||||
|  | var rexCSIDPackage = rext.W(regexp.MustCompile(`^package\s+(?P<name>[A-Za-z0-9_]+)\s*$`)) | ||||||
|  |  | ||||||
|  | var rexCSIDDef = rext.W(regexp.MustCompile(`^\s*type\s+(?P<name>[A-Za-z0-9_]+)\s+string\s*//\s*(@csid:type)\s+\[(?P<prefix>[A-Z0-9]{3})].*$`)) | ||||||
|  |  | ||||||
|  | var rexCSIDChecksumConst = rext.W(regexp.MustCompile(`const ChecksumCharsetIDGenerator = "(?P<cs>[A-Za-z0-9_]*)"`)) | ||||||
|  |  | ||||||
|  | //go:embed csid-generate.template | ||||||
|  | var templateCSIDGenerateText string | ||||||
|  |  | ||||||
|  | func GenerateCharsetIDSpecs(sourceDir string, destFile string, opt CSIDGenOptions) error { | ||||||
|  |  | ||||||
|  | 	debugOutput := langext.Coalesce(opt.DebugOutput, false) | ||||||
|  |  | ||||||
|  | 	files, err := os.ReadDir(sourceDir) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	oldChecksum := "N/A" | ||||||
|  | 	if _, err := os.Stat(destFile); !os.IsNotExist(err) { | ||||||
|  | 		content, err := os.ReadFile(destFile) | ||||||
|  | 		if err != nil { | ||||||
|  | 			return err | ||||||
|  | 		} | ||||||
|  | 		if m, ok := rexCSIDChecksumConst.MatchFirst(string(content)); ok { | ||||||
|  | 			oldChecksum = m.GroupByName("cs").Value() | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	files = langext.ArrFilter(files, func(v os.DirEntry) bool { return v.Name() != path.Base(destFile) }) | ||||||
|  | 	files = langext.ArrFilter(files, func(v os.DirEntry) bool { return strings.HasSuffix(v.Name(), ".go") }) | ||||||
|  | 	files = langext.ArrFilter(files, func(v os.DirEntry) bool { return !strings.HasSuffix(v.Name(), "_gen.go") }) | ||||||
|  | 	langext.SortBy(files, func(v os.DirEntry) string { return v.Name() }) | ||||||
|  |  | ||||||
|  | 	newChecksumStr := goext.GoextVersion | ||||||
|  | 	for _, f := range files { | ||||||
|  | 		content, err := os.ReadFile(path.Join(sourceDir, f.Name())) | ||||||
|  | 		if err != nil { | ||||||
|  | 			return err | ||||||
|  | 		} | ||||||
|  | 		newChecksumStr += "\n" + f.Name() + "\t" + cryptext.BytesSha256(content) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	newChecksum := cryptext.BytesSha256([]byte(newChecksumStr)) | ||||||
|  |  | ||||||
|  | 	if newChecksum != oldChecksum { | ||||||
|  | 		fmt.Printf("[CSIDGenerate] Checksum has changed ( %s -> %s ), will generate new file\n\n", oldChecksum, newChecksum) | ||||||
|  | 	} else { | ||||||
|  | 		fmt.Printf("[CSIDGenerate] Checksum unchanged ( %s ), nothing to do\n", oldChecksum) | ||||||
|  | 		return nil | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	allIDs := make([]CSIDDef, 0) | ||||||
|  |  | ||||||
|  | 	pkgname := "" | ||||||
|  |  | ||||||
|  | 	for _, f := range files { | ||||||
|  | 		if debugOutput { | ||||||
|  | 			fmt.Printf("========= %s =========\n\n", f.Name()) | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		fileIDs, pn, err := processCSIDFile(sourceDir, path.Join(sourceDir, f.Name()), debugOutput) | ||||||
|  | 		if err != nil { | ||||||
|  | 			return err | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		if debugOutput { | ||||||
|  | 			fmt.Printf("\n") | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		allIDs = append(allIDs, fileIDs...) | ||||||
|  |  | ||||||
|  | 		if pn != "" { | ||||||
|  | 			pkgname = pn | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if pkgname == "" { | ||||||
|  | 		return errors.New("no package name found in any file") | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	fdata, err := format.Source([]byte(fmtCSIDOutput(newChecksum, allIDs, pkgname))) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	err = os.WriteFile(destFile, fdata, 0o755) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return nil | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func processCSIDFile(basedir string, fn string, debugOutput bool) ([]CSIDDef, string, error) { | ||||||
|  | 	file, err := os.Open(fn) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return nil, "", err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	defer func() { _ = file.Close() }() | ||||||
|  |  | ||||||
|  | 	bin, err := io.ReadAll(file) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return nil, "", err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	lines := strings.Split(string(bin), "\n") | ||||||
|  |  | ||||||
|  | 	ids := make([]CSIDDef, 0) | ||||||
|  |  | ||||||
|  | 	pkgname := "" | ||||||
|  |  | ||||||
|  | 	for i, line := range lines { | ||||||
|  | 		if i == 0 && strings.HasPrefix(line, "// Code generated by") { | ||||||
|  | 			break | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		if match, ok := rexCSIDPackage.MatchFirst(line); i == 0 && ok { | ||||||
|  | 			pkgname = match.GroupByName("name").Value() | ||||||
|  | 			continue | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		if match, ok := rexCSIDDef.MatchFirst(line); ok { | ||||||
|  |  | ||||||
|  | 			rfp, err := filepath.Rel(basedir, fn) | ||||||
|  | 			if err != nil { | ||||||
|  | 				return nil, "", err | ||||||
|  | 			} | ||||||
|  |  | ||||||
|  | 			def := CSIDDef{ | ||||||
|  | 				File:         fn, | ||||||
|  | 				FileRelative: rfp, | ||||||
|  | 				Name:         match.GroupByName("name").Value(), | ||||||
|  | 				Prefix:       match.GroupByName("prefix").Value(), | ||||||
|  | 			} | ||||||
|  |  | ||||||
|  | 			if debugOutput { | ||||||
|  | 				fmt.Printf("Found ID definition { '%s' }\n", def.Name) | ||||||
|  | 			} | ||||||
|  |  | ||||||
|  | 			ids = append(ids, def) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return ids, pkgname, nil | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func fmtCSIDOutput(cs string, ids []CSIDDef, pkgname string) string { | ||||||
|  | 	templ := template.Must(template.New("csid-generate").Parse(templateCSIDGenerateText)) | ||||||
|  |  | ||||||
|  | 	buffer := bytes.Buffer{} | ||||||
|  |  | ||||||
|  | 	err := templ.Execute(&buffer, langext.H{ | ||||||
|  | 		"PkgName":      pkgname, | ||||||
|  | 		"Checksum":     cs, | ||||||
|  | 		"GoextVersion": goext.GoextVersion, | ||||||
|  | 		"IDs":          ids, | ||||||
|  | 	}) | ||||||
|  | 	if err != nil { | ||||||
|  | 		panic(err) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return buffer.String() | ||||||
|  | } | ||||||
							
								
								
									
										194
									
								
								bfcodegen/csid-generate.template
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										194
									
								
								bfcodegen/csid-generate.template
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,194 @@ | |||||||
|  | // Code generated by csid-generate.go DO NOT EDIT. | ||||||
|  |  | ||||||
|  | package {{.PkgName}} | ||||||
|  |  | ||||||
|  | import "crypto/rand" | ||||||
|  | import "crypto/sha256" | ||||||
|  | import "fmt" | ||||||
|  | import "github.com/go-playground/validator/v10" | ||||||
|  | import "github.com/rs/zerolog/log" | ||||||
|  | import "git.blackforestbytes.com/BlackForestBytes/goext/exerr" | ||||||
|  | import "git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | import "git.blackforestbytes.com/BlackForestBytes/goext/rext" | ||||||
|  | import "math/big" | ||||||
|  | import "reflect" | ||||||
|  | import "regexp" | ||||||
|  | import "strings" | ||||||
|  |  | ||||||
|  | const ChecksumCharsetIDGenerator = "{{.Checksum}}" // GoExtVersion: {{.GoextVersion}} | ||||||
|  |  | ||||||
|  | const idlen = 24 | ||||||
|  |  | ||||||
|  | const checklen = 1 | ||||||
|  |  | ||||||
|  | const idCharset = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz" | ||||||
|  | const idCharsetLen = len(idCharset) | ||||||
|  |  | ||||||
|  | var charSetReverseMap = generateCharsetMap() | ||||||
|  |  | ||||||
|  | const ({{range .IDs}} | ||||||
|  | 	prefix{{.Name}} = "{{.Prefix}}" {{end}} | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | var ({{range .IDs}} | ||||||
|  | 	regex{{.Name}} = generateRegex(prefix{{.Name}}) {{end}} | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | func generateRegex(prefix string) rext.Regex { | ||||||
|  | 	return rext.W(regexp.MustCompile(fmt.Sprintf("^%s[%s]{%d}[%s]{%d}$", prefix, idCharset, idlen-len(prefix)-checklen, idCharset, checklen))) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func generateCharsetMap() []int { | ||||||
|  | 	result := make([]int, 128) | ||||||
|  | 	for i := 0; i < len(result); i++ { | ||||||
|  | 		result[i] = -1 | ||||||
|  | 	} | ||||||
|  | 	for idx, chr := range idCharset { | ||||||
|  | 		result[int(chr)] = idx | ||||||
|  | 	} | ||||||
|  | 	return result | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func generateID(prefix string) string { | ||||||
|  | 	k := "" | ||||||
|  | 	csMax := big.NewInt(int64(idCharsetLen)) | ||||||
|  | 	checksum := 0 | ||||||
|  | 	for i := 0; i < idlen-len(prefix)-checklen; i++ { | ||||||
|  | 		v, err := rand.Int(rand.Reader, csMax) | ||||||
|  | 		if err != nil { | ||||||
|  | 			panic(err) | ||||||
|  | 		} | ||||||
|  | 		v64 := v.Int64() | ||||||
|  | 		k += string(idCharset[v64]) | ||||||
|  | 		checksum = (checksum + int(v64)) % (idCharsetLen) | ||||||
|  | 	} | ||||||
|  | 	checkstr := string(idCharset[checksum%idCharsetLen]) | ||||||
|  | 	return prefix + k + checkstr | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func generateIDFromSeed(prefix string, seed string) string { | ||||||
|  | 	h := sha256.New() | ||||||
|  |  | ||||||
|  | 	iddata := "" | ||||||
|  | 	for len(iddata) < idlen-len(prefix)-checklen { | ||||||
|  | 		h.Write([]byte(seed)) | ||||||
|  | 		bs := h.Sum(nil) | ||||||
|  | 		iddata += langext.NewAnyBaseConverter(idCharset).Encode(bs) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	checksum := 0 | ||||||
|  | 	for i := 0; i < idlen-len(prefix)-checklen; i++ { | ||||||
|  | 		ichr := int(iddata[i]) | ||||||
|  | 		checksum = (checksum + charSetReverseMap[ichr]) % (idCharsetLen) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	checkstr := string(idCharset[checksum%idCharsetLen]) | ||||||
|  |  | ||||||
|  | 	return prefix + iddata[:(idlen-len(prefix)-checklen)] + checkstr | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func validateID(prefix string, value string) error { | ||||||
|  | 	if len(value) != idlen { | ||||||
|  | 		return exerr.New(exerr.TypeInvalidCSID, "id has the wrong length").Str("value", value).Build() | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if !strings.HasPrefix(value, prefix) { | ||||||
|  | 		return exerr.New(exerr.TypeInvalidCSID, "id is missing the correct prefix").Str("value", value).Str("prefix", prefix).Build() | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	checksum := 0 | ||||||
|  | 	for i := len(prefix); i < len(value)-checklen; i++ { | ||||||
|  | 		ichr := int(value[i]) | ||||||
|  | 		if ichr < 0 || ichr >= len(charSetReverseMap) || charSetReverseMap[ichr] == -1 { | ||||||
|  | 			return exerr.New(exerr.TypeInvalidCSID, "id contains invalid characters").Str("value", value).Build() | ||||||
|  | 		} | ||||||
|  | 		checksum = (checksum + charSetReverseMap[ichr]) % (idCharsetLen) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	checkstr := string(idCharset[checksum%idCharsetLen]) | ||||||
|  |  | ||||||
|  | 	if !strings.HasSuffix(value, checkstr) { | ||||||
|  | 		return exerr.New(exerr.TypeInvalidCSID, "id checkstring is invalid").Str("value", value).Str("checkstr", checkstr).Build() | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return nil | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func getRawData(prefix string, value string) string { | ||||||
|  | 	if len(value) != idlen { | ||||||
|  | 		return "" | ||||||
|  | 	} | ||||||
|  | 	return value[len(prefix) : idlen-checklen] | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func getCheckString(prefix string, value string) string { | ||||||
|  | 	if len(value) != idlen { | ||||||
|  | 		return "" | ||||||
|  | 	} | ||||||
|  | 	return value[idlen-checklen:] | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func ValidateEntityID(vfl validator.FieldLevel) bool { | ||||||
|  | 	if !vfl.Field().CanInterface() { | ||||||
|  | 		log.Error().Msgf("Failed to validate EntityID (cannot interface ?!?)") | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	ifvalue := vfl.Field().Interface() | ||||||
|  |  | ||||||
|  | 	if value1, ok := ifvalue.(EntityID); ok { | ||||||
|  |  | ||||||
|  | 		if vfl.Field().Type().Kind() == reflect.Pointer && langext.IsNil(value1) { | ||||||
|  | 			return true | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		if err := value1.Valid(); err != nil { | ||||||
|  | 			log.Debug().Msgf("Failed to validate EntityID '%s' (%s)", value1.String(), err.Error()) | ||||||
|  | 			return false | ||||||
|  | 		} else { | ||||||
|  | 			return true | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 	} else { | ||||||
|  | 		log.Error().Msgf("Failed to validate EntityID (wrong type: %T)", ifvalue) | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | {{range .IDs}} | ||||||
|  |  | ||||||
|  | // ================================ {{.Name}} ({{.FileRelative}}) ================================ | ||||||
|  |  | ||||||
|  | func New{{.Name}}() {{.Name}} { | ||||||
|  | 	return {{.Name}}(generateID(prefix{{.Name}})) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (id {{.Name}}) Valid() error { | ||||||
|  | 	return validateID(prefix{{.Name}}, string(id)) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (i {{.Name}}) String() string { | ||||||
|  | 	return string(i) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (i {{.Name}}) Prefix() string { | ||||||
|  | 	return prefix{{.Name}} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (id {{.Name}}) Raw() string { | ||||||
|  | 	return getRawData(prefix{{.Name}}, string(id)) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (id {{.Name}}) CheckString() string { | ||||||
|  | 	return getCheckString(prefix{{.Name}}, string(id)) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (id {{.Name}}) IsZero() bool { | ||||||
|  | 	return id == "" | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (id {{.Name}}) Regex() rext.Regex { | ||||||
|  | 	return regex{{.Name}} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | {{end}} | ||||||
							
								
								
									
										52
									
								
								bfcodegen/csid-generate_test.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										52
									
								
								bfcodegen/csid-generate_test.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,52 @@ | |||||||
|  | package bfcodegen | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	_ "embed" | ||||||
|  | 	"fmt" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/cmdext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/tst" | ||||||
|  | 	"os" | ||||||
|  | 	"path/filepath" | ||||||
|  | 	"testing" | ||||||
|  | 	"time" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | //go:embed _test_example_1.tgz | ||||||
|  | var CSIDExampleModels1 []byte | ||||||
|  |  | ||||||
|  | func TestGenerateCSIDSpecs(t *testing.T) { | ||||||
|  |  | ||||||
|  | 	tmpFile := filepath.Join(t.TempDir(), langext.MustHexUUID()+".tgz") | ||||||
|  |  | ||||||
|  | 	tmpDir := filepath.Join(t.TempDir(), langext.MustHexUUID()) | ||||||
|  |  | ||||||
|  | 	err := os.WriteFile(tmpFile, CSIDExampleModels1, 0o777) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	t.Cleanup(func() { _ = os.Remove(tmpFile) }) | ||||||
|  |  | ||||||
|  | 	err = os.Mkdir(tmpDir, 0o777) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	t.Cleanup(func() { _ = os.RemoveAll(tmpFile) }) | ||||||
|  |  | ||||||
|  | 	_, err = cmdext.Runner("tar").Arg("-xvzf").Arg(tmpFile).Arg("-C").Arg(tmpDir).FailOnExitCode().FailOnTimeout().Timeout(time.Minute).Run() | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	err = GenerateCharsetIDSpecs(tmpDir, tmpDir+"/csid_gen.go", CSIDGenOptions{DebugOutput: langext.PTrue}) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	err = GenerateCharsetIDSpecs(tmpDir, tmpDir+"/csid_gen.go", CSIDGenOptions{DebugOutput: langext.PTrue}) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	fmt.Println() | ||||||
|  | 	fmt.Println() | ||||||
|  | 	fmt.Println() | ||||||
|  | 	fmt.Println("=====================================================================================================") | ||||||
|  | 	fmt.Println(string(tst.Must(os.ReadFile(tmpDir + "/csid_gen.go"))(t))) | ||||||
|  | 	fmt.Println("=====================================================================================================") | ||||||
|  | 	fmt.Println() | ||||||
|  | 	fmt.Println() | ||||||
|  | 	fmt.Println() | ||||||
|  | } | ||||||
							
								
								
									
										373
									
								
								bfcodegen/enum-generate.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										373
									
								
								bfcodegen/enum-generate.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,373 @@ | |||||||
|  | package bfcodegen | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"bytes" | ||||||
|  | 	_ "embed" | ||||||
|  | 	"encoding/json" | ||||||
|  | 	"errors" | ||||||
|  | 	"fmt" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/cryptext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/rext" | ||||||
|  | 	"go/format" | ||||||
|  | 	"io" | ||||||
|  | 	"os" | ||||||
|  | 	"path" | ||||||
|  | 	"path/filepath" | ||||||
|  | 	"reflect" | ||||||
|  | 	"regexp" | ||||||
|  | 	"strings" | ||||||
|  | 	"text/template" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | type EnumDefVal struct { | ||||||
|  | 	VarName     string | ||||||
|  | 	Value       string | ||||||
|  | 	Description *string | ||||||
|  | 	Data        *map[string]any | ||||||
|  | 	RawComment  *string | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type EnumDef struct { | ||||||
|  | 	File         string | ||||||
|  | 	FileRelative string | ||||||
|  | 	EnumTypeName string | ||||||
|  | 	Type         string | ||||||
|  | 	Values       []EnumDefVal | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type EnumGenOptions struct { | ||||||
|  | 	DebugOutput *bool | ||||||
|  | 	GoFormat    *bool | ||||||
|  | } | ||||||
|  |  | ||||||
|  | var rexEnumPackage = rext.W(regexp.MustCompile(`^package\s+(?P<name>[A-Za-z0-9_]+)\s*$`)) | ||||||
|  |  | ||||||
|  | var rexEnumDef = rext.W(regexp.MustCompile(`^\s*type\s+(?P<name>[A-Za-z0-9_]+)\s+(?P<type>[A-Za-z0-9_]+)\s*//\s*(@enum:type).*$`)) | ||||||
|  |  | ||||||
|  | var rexEnumValueDef = rext.W(regexp.MustCompile(`^\s*(?P<name>[A-Za-z0-9_]+)\s+(?P<type>[A-Za-z0-9_]+)\s*=\s*(?P<value>("[/@A-Za-z0-9_:\s\-.]*"|[0-9]+))\s*(//(?P<comm>.*))?.*$`)) | ||||||
|  |  | ||||||
|  | var rexEnumChecksumConst = rext.W(regexp.MustCompile(`const ChecksumEnumGenerator = "(?P<cs>[A-Za-z0-9_]*)"`)) | ||||||
|  |  | ||||||
|  | //go:embed enum-generate.template | ||||||
|  | var templateEnumGenerateText string | ||||||
|  |  | ||||||
|  | func GenerateEnumSpecs(sourceDir string, destFile string, opt EnumGenOptions) error { | ||||||
|  |  | ||||||
|  | 	oldChecksum := "N/A" | ||||||
|  | 	if _, err := os.Stat(destFile); !os.IsNotExist(err) { | ||||||
|  | 		content, err := os.ReadFile(destFile) | ||||||
|  | 		if err != nil { | ||||||
|  | 			return err | ||||||
|  | 		} | ||||||
|  | 		if m, ok := rexEnumChecksumConst.MatchFirst(string(content)); ok { | ||||||
|  | 			oldChecksum = m.GroupByName("cs").Value() | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	gocode, _, changed, err := _generateEnumSpecs(sourceDir, destFile, oldChecksum, langext.Coalesce(opt.GoFormat, true), langext.Coalesce(opt.DebugOutput, false)) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if !changed { | ||||||
|  | 		return nil | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	err = os.WriteFile(destFile, []byte(gocode), 0o755) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return nil | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func _generateEnumSpecs(sourceDir string, destFile string, oldChecksum string, gofmt bool, debugOutput bool) (string, string, bool, error) { | ||||||
|  |  | ||||||
|  | 	files, err := os.ReadDir(sourceDir) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return "", "", false, err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	files = langext.ArrFilter(files, func(v os.DirEntry) bool { return v.Name() != path.Base(destFile) }) | ||||||
|  | 	files = langext.ArrFilter(files, func(v os.DirEntry) bool { return strings.HasSuffix(v.Name(), ".go") }) | ||||||
|  | 	files = langext.ArrFilter(files, func(v os.DirEntry) bool { return !strings.HasSuffix(v.Name(), "_gen.go") }) | ||||||
|  | 	langext.SortBy(files, func(v os.DirEntry) string { return v.Name() }) | ||||||
|  |  | ||||||
|  | 	newChecksumStr := goext.GoextVersion | ||||||
|  | 	for _, f := range files { | ||||||
|  | 		content, err := os.ReadFile(path.Join(sourceDir, f.Name())) | ||||||
|  | 		if err != nil { | ||||||
|  | 			return "", "", false, err | ||||||
|  | 		} | ||||||
|  | 		newChecksumStr += "\n" + f.Name() + "\t" + cryptext.BytesSha256(content) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	newChecksum := cryptext.BytesSha256([]byte(newChecksumStr)) | ||||||
|  |  | ||||||
|  | 	if newChecksum != oldChecksum { | ||||||
|  | 		fmt.Printf("[EnumGenerate] Checksum has changed ( %s -> %s ), will generate new file\n\n", oldChecksum, newChecksum) | ||||||
|  | 	} else { | ||||||
|  | 		fmt.Printf("[EnumGenerate] Checksum unchanged ( %s ), nothing to do\n", oldChecksum) | ||||||
|  | 		return "", oldChecksum, false, nil | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	allEnums := make([]EnumDef, 0) | ||||||
|  |  | ||||||
|  | 	pkgname := "" | ||||||
|  |  | ||||||
|  | 	for _, f := range files { | ||||||
|  | 		if debugOutput { | ||||||
|  | 			fmt.Printf("========= %s =========\n\n", f.Name()) | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		fileEnums, pn, err := processEnumFile(sourceDir, path.Join(sourceDir, f.Name()), debugOutput) | ||||||
|  | 		if err != nil { | ||||||
|  | 			return "", "", false, err | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		if debugOutput { | ||||||
|  | 			fmt.Printf("\n") | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		allEnums = append(allEnums, fileEnums...) | ||||||
|  |  | ||||||
|  | 		if pn != "" { | ||||||
|  | 			pkgname = pn | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if pkgname == "" { | ||||||
|  | 		return "", "", false, errors.New("no package name found in any file") | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	rdata := fmtEnumOutput(newChecksum, allEnums, pkgname) | ||||||
|  |  | ||||||
|  | 	if !gofmt { | ||||||
|  | 		return rdata, newChecksum, true, nil | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	fdata, err := format.Source([]byte(rdata)) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return "", "", false, err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return string(fdata), newChecksum, true, nil | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func processEnumFile(basedir string, fn string, debugOutput bool) ([]EnumDef, string, error) { | ||||||
|  | 	file, err := os.Open(fn) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return nil, "", err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	defer func() { _ = file.Close() }() | ||||||
|  |  | ||||||
|  | 	bin, err := io.ReadAll(file) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return nil, "", err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	lines := strings.Split(string(bin), "\n") | ||||||
|  |  | ||||||
|  | 	enums := make([]EnumDef, 0) | ||||||
|  |  | ||||||
|  | 	pkgname := "" | ||||||
|  |  | ||||||
|  | 	for i, line := range lines { | ||||||
|  | 		if i == 0 && strings.HasPrefix(line, "// Code generated by") { | ||||||
|  | 			break | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		if match, ok := rexEnumPackage.MatchFirst(line); i == 0 && ok { | ||||||
|  | 			pkgname = match.GroupByName("name").Value() | ||||||
|  | 			continue | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		if match, ok := rexEnumDef.MatchFirst(line); ok { | ||||||
|  |  | ||||||
|  | 			rfp, err := filepath.Rel(basedir, fn) | ||||||
|  | 			if err != nil { | ||||||
|  | 				return nil, "", err | ||||||
|  | 			} | ||||||
|  |  | ||||||
|  | 			def := EnumDef{ | ||||||
|  | 				File:         fn, | ||||||
|  | 				FileRelative: rfp, | ||||||
|  | 				EnumTypeName: match.GroupByName("name").Value(), | ||||||
|  | 				Type:         match.GroupByName("type").Value(), | ||||||
|  | 				Values:       make([]EnumDefVal, 0), | ||||||
|  | 			} | ||||||
|  | 			enums = append(enums, def) | ||||||
|  |  | ||||||
|  | 			if debugOutput { | ||||||
|  | 				fmt.Printf("Found enum definition { '%s' -> '%s' }\n", def.EnumTypeName, def.Type) | ||||||
|  | 			} | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		if match, ok := rexEnumValueDef.MatchFirst(line); ok { | ||||||
|  | 			typename := match.GroupByName("type").Value() | ||||||
|  |  | ||||||
|  | 			comment := match.GroupByNameOrEmpty("comm").ValueOrNil() | ||||||
|  | 			var descr *string = nil | ||||||
|  | 			var data *map[string]any = nil | ||||||
|  | 			if comment != nil { | ||||||
|  | 				comment = langext.Ptr(strings.TrimSpace(*comment)) | ||||||
|  | 				if strings.HasPrefix(*comment, "{") { | ||||||
|  | 					if v, ok := tryParseDataComment(*comment); ok { | ||||||
|  | 						data = &v | ||||||
|  | 						if anyDataDescr, ok := v["description"]; ok { | ||||||
|  | 							if dataDescr, ok := anyDataDescr.(string); ok { | ||||||
|  | 								descr = &dataDescr | ||||||
|  | 							} | ||||||
|  | 						} | ||||||
|  | 					} else { | ||||||
|  | 						descr = comment | ||||||
|  | 					} | ||||||
|  | 				} else { | ||||||
|  | 					descr = comment | ||||||
|  | 				} | ||||||
|  | 			} | ||||||
|  |  | ||||||
|  | 			def := EnumDefVal{ | ||||||
|  | 				VarName:     match.GroupByName("name").Value(), | ||||||
|  | 				Value:       match.GroupByName("value").Value(), | ||||||
|  | 				RawComment:  comment, | ||||||
|  | 				Description: descr, | ||||||
|  | 				Data:        data, | ||||||
|  | 			} | ||||||
|  |  | ||||||
|  | 			found := false | ||||||
|  | 			for i, v := range enums { | ||||||
|  | 				if v.EnumTypeName == typename { | ||||||
|  | 					enums[i].Values = append(enums[i].Values, def) | ||||||
|  | 					found = true | ||||||
|  |  | ||||||
|  | 					if debugOutput { | ||||||
|  | 						if def.Description != nil { | ||||||
|  | 							fmt.Printf("Found enum value [%s] for '%s'  ('%s')\n", def.Value, def.VarName, *def.Description) | ||||||
|  | 						} else { | ||||||
|  | 							fmt.Printf("Found enum value [%s] for '%s'\n", def.Value, def.VarName) | ||||||
|  | 						} | ||||||
|  | 					} | ||||||
|  | 					break | ||||||
|  | 				} | ||||||
|  | 			} | ||||||
|  | 			if !found { | ||||||
|  | 				if debugOutput { | ||||||
|  | 					fmt.Printf("Found non-enum value [%s] for '%s' ( looks like enum value, but no matching @enum:type )\n", def.Value, def.VarName) | ||||||
|  | 				} | ||||||
|  | 			} | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return enums, pkgname, nil | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func tryParseDataComment(s string) (map[string]any, bool) { | ||||||
|  |  | ||||||
|  | 	r := make(map[string]any) | ||||||
|  |  | ||||||
|  | 	err := json.Unmarshal([]byte(s), &r) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return nil, false | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	for _, v := range r { | ||||||
|  |  | ||||||
|  | 		rv := reflect.ValueOf(v) | ||||||
|  |  | ||||||
|  | 		if rv.Kind() == reflect.Ptr && rv.IsNil() { | ||||||
|  | 			continue | ||||||
|  | 		} | ||||||
|  | 		if rv.Kind() == reflect.Bool { | ||||||
|  | 			continue | ||||||
|  | 		} | ||||||
|  | 		if rv.Kind() == reflect.String { | ||||||
|  | 			continue | ||||||
|  | 		} | ||||||
|  | 		if rv.Kind() == reflect.Int64 { | ||||||
|  | 			continue | ||||||
|  | 		} | ||||||
|  | 		if rv.Kind() == reflect.Float64 { | ||||||
|  | 			continue | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		return nil, false | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return r, true | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func fmtEnumOutput(cs string, enums []EnumDef, pkgname string) string { | ||||||
|  |  | ||||||
|  | 	templ := template.New("enum-generate") | ||||||
|  |  | ||||||
|  | 	templ = templ.Funcs(template.FuncMap{ | ||||||
|  | 		"boolToStr": func(b bool) string { return langext.Conditional(b, "true", "false") }, | ||||||
|  | 		"deref":     func(v *string) string { return *v }, | ||||||
|  | 		"trimSpace": func(str string) string { return strings.TrimSpace(str) }, | ||||||
|  | 		"hasStr":    func(v EnumDef) bool { return v.Type == "string" }, | ||||||
|  | 		"hasDescr": func(v EnumDef) bool { | ||||||
|  | 			return langext.ArrAll(v.Values, func(val EnumDefVal) bool { return val.Description != nil }) | ||||||
|  | 		}, | ||||||
|  | 		"hasData": func(v EnumDef) bool { | ||||||
|  | 			return len(v.Values) > 0 && langext.ArrAll(v.Values, func(val EnumDefVal) bool { return val.Data != nil }) | ||||||
|  | 		}, | ||||||
|  | 		"gostr": func(v any) string { | ||||||
|  | 			return fmt.Sprintf("%#+v", v) | ||||||
|  | 		}, | ||||||
|  | 		"goobj": func(name string, v any) string { | ||||||
|  | 			return fmt.Sprintf("%#+v", v) | ||||||
|  | 		}, | ||||||
|  | 		"godatakey": func(v string) string { | ||||||
|  | 			return strings.ToUpper(v[0:1]) + v[1:] | ||||||
|  | 		}, | ||||||
|  | 		"godatavalue": func(v any) string { | ||||||
|  | 			return fmt.Sprintf("%#+v", v) | ||||||
|  | 		}, | ||||||
|  | 		"godatatype": func(v any) string { | ||||||
|  | 			return fmt.Sprintf("%T", v) | ||||||
|  | 		}, | ||||||
|  | 		"mapindex": func(v map[string]any, k string) any { | ||||||
|  | 			return v[k] | ||||||
|  | 		}, | ||||||
|  | 		"generalDataKeys": func(v EnumDef) map[string]string { | ||||||
|  | 			r0 := make(map[string]int) | ||||||
|  |  | ||||||
|  | 			for _, eval := range v.Values { | ||||||
|  | 				for k := range *eval.Data { | ||||||
|  | 					if ctr, ok := r0[k]; ok { | ||||||
|  | 						r0[k] = ctr + 1 | ||||||
|  | 					} else { | ||||||
|  | 						r0[k] = 1 | ||||||
|  | 					} | ||||||
|  | 				} | ||||||
|  | 			} | ||||||
|  |  | ||||||
|  | 			r1 := langext.MapToArr(r0) | ||||||
|  | 			r2 := langext.ArrFilter(r1, func(p langext.MapEntry[string, int]) bool { return p.Value == len(v.Values) }) | ||||||
|  | 			r3 := langext.ArrMap(r2, func(p langext.MapEntry[string, int]) string { return p.Key }) | ||||||
|  | 			r4 := langext.ArrToKVMap(r3, func(p string) string { return p }, func(p string) string { return fmt.Sprintf("%T", (*v.Values[0].Data)[p]) }) | ||||||
|  |  | ||||||
|  | 			return r4 | ||||||
|  | 		}, | ||||||
|  | 	}) | ||||||
|  |  | ||||||
|  | 	templ = template.Must(templ.Parse(templateEnumGenerateText)) | ||||||
|  |  | ||||||
|  | 	buffer := bytes.Buffer{} | ||||||
|  |  | ||||||
|  | 	err := templ.Execute(&buffer, langext.H{ | ||||||
|  | 		"PkgName":      pkgname, | ||||||
|  | 		"Checksum":     cs, | ||||||
|  | 		"GoextVersion": goext.GoextVersion, | ||||||
|  | 		"Enums":        enums, | ||||||
|  | 	}) | ||||||
|  | 	if err != nil { | ||||||
|  | 		panic(err) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return buffer.String() | ||||||
|  | } | ||||||
							
								
								
									
										175
									
								
								bfcodegen/enum-generate.template
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										175
									
								
								bfcodegen/enum-generate.template
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,175 @@ | |||||||
|  | // Code generated by enum-generate.go DO NOT EDIT. | ||||||
|  |  | ||||||
|  | package {{.PkgName}} | ||||||
|  |  | ||||||
|  | import "git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | import "git.blackforestbytes.com/BlackForestBytes/goext/enums" | ||||||
|  |  | ||||||
|  | const ChecksumEnumGenerator = "{{.Checksum}}" // GoExtVersion: {{.GoextVersion}} | ||||||
|  |  | ||||||
|  | {{ $pkgname  := .PkgName }} | ||||||
|  |  | ||||||
|  | {{range .Enums}} | ||||||
|  |  | ||||||
|  | {{ $hasStr   := ( . | hasStr   ) }} | ||||||
|  | {{ $hasDescr := ( . | hasDescr ) }} | ||||||
|  | {{ $hasData  := ( . | hasData  ) }} | ||||||
|  |  | ||||||
|  | // ================================ {{.EnumTypeName}} ================================ | ||||||
|  | // | ||||||
|  | // File:       {{.FileRelative}} | ||||||
|  | // StringEnum: {{$hasStr   | boolToStr}} | ||||||
|  | // DescrEnum:  {{$hasDescr | boolToStr}} | ||||||
|  | // DataEnum:   {{$hasData  | boolToStr}} | ||||||
|  | // | ||||||
|  |  | ||||||
|  | {{ $typename := .EnumTypeName }} | ||||||
|  | {{ $enumdef  := . }} | ||||||
|  |  | ||||||
|  | var __{{.EnumTypeName}}Values = []{{.EnumTypeName}}{ {{range .Values}} | ||||||
|  | 	{{.VarName}}, {{end}} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | {{if $hasDescr}} | ||||||
|  | var __{{.EnumTypeName}}Descriptions = map[{{.EnumTypeName}}]string{ {{range .Values}} | ||||||
|  | 	{{.VarName}}: {{.Description | deref | trimSpace | gostr}}, {{end}} | ||||||
|  | } | ||||||
|  | {{end}} | ||||||
|  |  | ||||||
|  | {{if $hasData}} | ||||||
|  | type {{ .EnumTypeName }}Data struct { {{ range $datakey, $datatype := ($enumdef | generalDataKeys)  }} | ||||||
|  |     {{ $datakey | godatakey }} {{ $datatype }} `json:"{{ $datakey }}"` {{ end }} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | var __{{.EnumTypeName}}Data = map[{{.EnumTypeName}}]{{.EnumTypeName}}Data{ {{range .Values}} {{ $enumvalue := . }} | ||||||
|  | 	{{.VarName}}: {{ $typename }}Data{ {{ range $datakey, $datatype := $enumdef | generalDataKeys  }} | ||||||
|  | 	    {{ $datakey | godatakey }}: {{ (mapindex $enumvalue.Data $datakey) | godatavalue }}, {{ end }} | ||||||
|  | 	}, {{end}} | ||||||
|  | } | ||||||
|  | {{end}} | ||||||
|  |  | ||||||
|  | var __{{.EnumTypeName}}Varnames = map[{{.EnumTypeName}}]string{ {{range .Values}} | ||||||
|  | 	{{.VarName}}: "{{.VarName}}", {{end}} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (e {{.EnumTypeName}}) Valid() bool { | ||||||
|  | 	return langext.InArray(e, __{{.EnumTypeName}}Values) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (e {{.EnumTypeName}}) Values() []{{.EnumTypeName}} { | ||||||
|  | 	return __{{.EnumTypeName}}Values | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (e {{.EnumTypeName}}) ValuesAny() []any { | ||||||
|  | 	return langext.ArrCastToAny(__{{.EnumTypeName}}Values) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (e {{.EnumTypeName}}) ValuesMeta() []enums.EnumMetaValue { | ||||||
|  | 	return {{.EnumTypeName}}ValuesMeta() | ||||||
|  | } | ||||||
|  |  | ||||||
|  | {{if $hasStr}} | ||||||
|  | func (e {{.EnumTypeName}}) String() string { | ||||||
|  | 	return string(e) | ||||||
|  | } | ||||||
|  | {{end}} | ||||||
|  |  | ||||||
|  | {{if $hasDescr}} | ||||||
|  | func (e {{.EnumTypeName}}) Description() string { | ||||||
|  | 	if d, ok := __{{.EnumTypeName}}Descriptions[e]; ok { | ||||||
|  | 		return d | ||||||
|  | 	} | ||||||
|  | 	return "" | ||||||
|  | } | ||||||
|  | {{end}} | ||||||
|  |  | ||||||
|  | {{if $hasData}} | ||||||
|  | func (e {{.EnumTypeName}}) Data() {{.EnumTypeName}}Data { | ||||||
|  | 	if d, ok := __{{.EnumTypeName}}Data[e]; ok { | ||||||
|  | 		return d | ||||||
|  | 	} | ||||||
|  | 	return {{.EnumTypeName}}Data{} | ||||||
|  | } | ||||||
|  | {{end}} | ||||||
|  |  | ||||||
|  | func (e {{.EnumTypeName}}) VarName() string { | ||||||
|  | 	if d, ok := __{{.EnumTypeName}}Varnames[e]; ok { | ||||||
|  | 		return d | ||||||
|  | 	} | ||||||
|  | 	return "" | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (e {{.EnumTypeName}}) TypeName() string { | ||||||
|  | 	return "{{$typename}}" | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (e {{.EnumTypeName}}) PackageName() string { | ||||||
|  | 	return "{{$pkgname }}" | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (e {{.EnumTypeName}}) Meta() enums.EnumMetaValue { | ||||||
|  |     {{if $hasDescr}} return enums.EnumMetaValue{VarName: e.VarName(), Value: e, Description: langext.Ptr(e.Description())} {{else}} return enums.EnumMetaValue{VarName: e.VarName(), Value: e, Description: nil} {{end}} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | {{if $hasDescr}} | ||||||
|  | func (e {{.EnumTypeName}}) DescriptionMeta() enums.EnumDescriptionMetaValue { | ||||||
|  |     return enums.EnumDescriptionMetaValue{VarName: e.VarName(), Value: e, Description: e.Description()} | ||||||
|  | } | ||||||
|  | {{end}} | ||||||
|  |  | ||||||
|  | {{if $hasData}} | ||||||
|  | func (e {{.EnumTypeName}}) DataMeta() enums.EnumDataMetaValue { | ||||||
|  |     return enums.EnumDataMetaValue{ | ||||||
|  |         VarName: e.VarName(), | ||||||
|  |         Value: e, | ||||||
|  |         {{if $hasDescr}} Description: langext.Ptr(e.Description()), {{else}} Description: nil, {{end}} | ||||||
|  |         Data: map[string]any{ | ||||||
|  |             {{ range $datakey, $datatype := $enumdef | generalDataKeys  }} "{{ $datakey }}": e.Data().{{ $datakey | godatakey }}, | ||||||
|  |             {{ end }} | ||||||
|  |         }, | ||||||
|  |     } | ||||||
|  | } | ||||||
|  | {{end}} | ||||||
|  |  | ||||||
|  | func Parse{{.EnumTypeName}}(vv string) ({{.EnumTypeName}}, bool) { | ||||||
|  | 	for _, ev := range __{{.EnumTypeName}}Values { | ||||||
|  | 		if string(ev) == vv { | ||||||
|  | 			return ev, true | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | 	return "", false | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func {{.EnumTypeName}}Values() []{{.EnumTypeName}} { | ||||||
|  | 	return __{{.EnumTypeName}}Values | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func {{.EnumTypeName}}ValuesMeta() []enums.EnumMetaValue { | ||||||
|  | 	return []enums.EnumMetaValue{ {{range .Values}} | ||||||
|  |             {{.VarName}}.Meta(), {{end}} | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func {{.EnumTypeName}}ValuesDataMeta() []enums.EnumDataMetaValue { | ||||||
|  | 	return []enums.EnumDataMetaValue{ {{range .Values}} | ||||||
|  |             {{.VarName}}.DataMeta(), {{end}} | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | {{if $hasDescr}} | ||||||
|  | func {{.EnumTypeName}}ValuesDescriptionMeta() []enums.EnumDescriptionMetaValue { | ||||||
|  | 	return []enums.EnumDescriptionMetaValue{ {{range .Values}} | ||||||
|  |             {{.VarName}}.DescriptionMeta(), {{end}} | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  | {{end}} | ||||||
|  |  | ||||||
|  | {{end}} | ||||||
|  |  | ||||||
|  | // ================================ ================= ================================ | ||||||
|  |  | ||||||
|  | func AllPackageEnums() []enums.Enum { | ||||||
|  |     return []enums.Enum{ {{range .Enums}} | ||||||
|  |         {{ if gt (len .Values) 0 }} {{  $v := index .Values 0 }} {{ $v.VarName}}, {{end}} // {{ .EnumTypeName }} {{end}} | ||||||
|  |     } | ||||||
|  | } | ||||||
							
								
								
									
										91
									
								
								bfcodegen/enum-generate_test.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										91
									
								
								bfcodegen/enum-generate_test.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,91 @@ | |||||||
|  | package bfcodegen | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	_ "embed" | ||||||
|  | 	"fmt" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/cmdext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/tst" | ||||||
|  | 	"os" | ||||||
|  | 	"path/filepath" | ||||||
|  | 	"testing" | ||||||
|  | 	"time" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | //go:embed _test_example_1.tgz | ||||||
|  | var EnumExampleModels1 []byte | ||||||
|  |  | ||||||
|  | //go:embed _test_example_2.tgz | ||||||
|  | var EnumExampleModels2 []byte | ||||||
|  |  | ||||||
|  | func TestGenerateEnumSpecs(t *testing.T) { | ||||||
|  |  | ||||||
|  | 	tmpFile := filepath.Join(t.TempDir(), langext.MustHexUUID()+".tgz") | ||||||
|  |  | ||||||
|  | 	tmpDir := filepath.Join(t.TempDir(), langext.MustHexUUID()) | ||||||
|  |  | ||||||
|  | 	err := os.WriteFile(tmpFile, EnumExampleModels1, 0o777) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	t.Cleanup(func() { _ = os.Remove(tmpFile) }) | ||||||
|  |  | ||||||
|  | 	err = os.Mkdir(tmpDir, 0o777) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	t.Cleanup(func() { _ = os.RemoveAll(tmpFile) }) | ||||||
|  |  | ||||||
|  | 	_, err = cmdext.Runner("tar").Arg("-xvzf").Arg(tmpFile).Arg("-C").Arg(tmpDir).FailOnExitCode().FailOnTimeout().Timeout(time.Minute).Run() | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	s1, cs1, _, err := _generateEnumSpecs(tmpDir, "", "N/A", true, true) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	s2, cs2, _, err := _generateEnumSpecs(tmpDir, "", "N/A", true, true) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	tst.AssertEqual(t, cs1, cs2) | ||||||
|  | 	tst.AssertEqual(t, s1, s2) | ||||||
|  |  | ||||||
|  | 	fmt.Println() | ||||||
|  | 	fmt.Println() | ||||||
|  | 	fmt.Println() | ||||||
|  | 	fmt.Println("=====================================================================================================") | ||||||
|  | 	fmt.Println(s1) | ||||||
|  | 	fmt.Println("=====================================================================================================") | ||||||
|  | 	fmt.Println() | ||||||
|  | 	fmt.Println() | ||||||
|  | 	fmt.Println() | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestGenerateEnumSpecsData(t *testing.T) { | ||||||
|  |  | ||||||
|  | 	tmpFile := filepath.Join(t.TempDir(), langext.MustHexUUID()+".tgz") | ||||||
|  |  | ||||||
|  | 	tmpDir := filepath.Join(t.TempDir(), langext.MustHexUUID()) | ||||||
|  |  | ||||||
|  | 	err := os.WriteFile(tmpFile, EnumExampleModels2, 0o777) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	t.Cleanup(func() { _ = os.Remove(tmpFile) }) | ||||||
|  |  | ||||||
|  | 	err = os.Mkdir(tmpDir, 0o777) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	t.Cleanup(func() { _ = os.RemoveAll(tmpFile) }) | ||||||
|  |  | ||||||
|  | 	_, err = cmdext.Runner("tar").Arg("-xvzf").Arg(tmpFile).Arg("-C").Arg(tmpDir).FailOnExitCode().FailOnTimeout().Timeout(time.Minute).Run() | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	s1, _, _, err := _generateEnumSpecs(tmpDir, "", "", true, true) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	fmt.Println() | ||||||
|  | 	fmt.Println() | ||||||
|  | 	fmt.Println() | ||||||
|  | 	fmt.Println("=====================================================================================================") | ||||||
|  | 	fmt.Println(s1) | ||||||
|  | 	fmt.Println("=====================================================================================================") | ||||||
|  | 	fmt.Println() | ||||||
|  | 	fmt.Println() | ||||||
|  | 	fmt.Println() | ||||||
|  | } | ||||||
							
								
								
									
										198
									
								
								bfcodegen/id-generate.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										198
									
								
								bfcodegen/id-generate.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,198 @@ | |||||||
|  | package bfcodegen | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"bytes" | ||||||
|  | 	_ "embed" | ||||||
|  | 	"errors" | ||||||
|  | 	"fmt" | ||||||
|  | 	"go/format" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/cryptext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/rext" | ||||||
|  | 	"io" | ||||||
|  | 	"os" | ||||||
|  | 	"path" | ||||||
|  | 	"path/filepath" | ||||||
|  | 	"regexp" | ||||||
|  | 	"strings" | ||||||
|  | 	"text/template" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | type IDDef struct { | ||||||
|  | 	File         string | ||||||
|  | 	FileRelative string | ||||||
|  | 	Name         string | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type IDGenOptions struct { | ||||||
|  | 	DebugOutput *bool | ||||||
|  | } | ||||||
|  |  | ||||||
|  | var rexIDPackage = rext.W(regexp.MustCompile(`^package\s+(?P<name>[A-Za-z0-9_]+)\s*$`)) | ||||||
|  |  | ||||||
|  | var rexIDDef = rext.W(regexp.MustCompile(`^\s*type\s+(?P<name>[A-Za-z0-9_]+)\s+string\s*//\s*(@id:type).*$`)) | ||||||
|  |  | ||||||
|  | var rexIDChecksumConst = rext.W(regexp.MustCompile(`const ChecksumIDGenerator = "(?P<cs>[A-Za-z0-9_]*)"`)) | ||||||
|  |  | ||||||
|  | //go:embed id-generate.template | ||||||
|  | var templateIDGenerateText string | ||||||
|  |  | ||||||
|  | func GenerateIDSpecs(sourceDir string, destFile string, opt IDGenOptions) error { | ||||||
|  |  | ||||||
|  | 	debugOutput := langext.Coalesce(opt.DebugOutput, false) | ||||||
|  |  | ||||||
|  | 	files, err := os.ReadDir(sourceDir) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	oldChecksum := "N/A" | ||||||
|  | 	if _, err := os.Stat(destFile); !os.IsNotExist(err) { | ||||||
|  | 		content, err := os.ReadFile(destFile) | ||||||
|  | 		if err != nil { | ||||||
|  | 			return err | ||||||
|  | 		} | ||||||
|  | 		if m, ok := rexIDChecksumConst.MatchFirst(string(content)); ok { | ||||||
|  | 			oldChecksum = m.GroupByName("cs").Value() | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	files = langext.ArrFilter(files, func(v os.DirEntry) bool { return v.Name() != path.Base(destFile) }) | ||||||
|  | 	files = langext.ArrFilter(files, func(v os.DirEntry) bool { return strings.HasSuffix(v.Name(), ".go") }) | ||||||
|  | 	files = langext.ArrFilter(files, func(v os.DirEntry) bool { return !strings.HasSuffix(v.Name(), "_gen.go") }) | ||||||
|  | 	langext.SortBy(files, func(v os.DirEntry) string { return v.Name() }) | ||||||
|  |  | ||||||
|  | 	newChecksumStr := goext.GoextVersion | ||||||
|  | 	for _, f := range files { | ||||||
|  | 		content, err := os.ReadFile(path.Join(sourceDir, f.Name())) | ||||||
|  | 		if err != nil { | ||||||
|  | 			return err | ||||||
|  | 		} | ||||||
|  | 		newChecksumStr += "\n" + f.Name() + "\t" + cryptext.BytesSha256(content) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	newChecksum := cryptext.BytesSha256([]byte(newChecksumStr)) | ||||||
|  |  | ||||||
|  | 	if newChecksum != oldChecksum { | ||||||
|  | 		fmt.Printf("[IDGenerate] Checksum has changed ( %s -> %s ), will generate new file\n\n", oldChecksum, newChecksum) | ||||||
|  | 	} else { | ||||||
|  | 		fmt.Printf("[IDGenerate] Checksum unchanged ( %s ), nothing to do\n", oldChecksum) | ||||||
|  | 		return nil | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	allIDs := make([]IDDef, 0) | ||||||
|  |  | ||||||
|  | 	pkgname := "" | ||||||
|  |  | ||||||
|  | 	for _, f := range files { | ||||||
|  | 		if debugOutput { | ||||||
|  | 			fmt.Printf("========= %s =========\n\n", f.Name()) | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		fileIDs, pn, err := processIDFile(sourceDir, path.Join(sourceDir, f.Name()), debugOutput) | ||||||
|  | 		if err != nil { | ||||||
|  | 			return err | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		if debugOutput { | ||||||
|  | 			fmt.Printf("\n") | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		allIDs = append(allIDs, fileIDs...) | ||||||
|  |  | ||||||
|  | 		if pn != "" { | ||||||
|  | 			pkgname = pn | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if pkgname == "" { | ||||||
|  | 		return errors.New("no package name found in any file") | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	fdata, err := format.Source([]byte(fmtIDOutput(newChecksum, allIDs, pkgname))) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	err = os.WriteFile(destFile, fdata, 0o755) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return nil | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func processIDFile(basedir string, fn string, debugOutput bool) ([]IDDef, string, error) { | ||||||
|  | 	file, err := os.Open(fn) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return nil, "", err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	defer func() { _ = file.Close() }() | ||||||
|  |  | ||||||
|  | 	bin, err := io.ReadAll(file) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return nil, "", err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	lines := strings.Split(string(bin), "\n") | ||||||
|  |  | ||||||
|  | 	ids := make([]IDDef, 0) | ||||||
|  |  | ||||||
|  | 	pkgname := "" | ||||||
|  |  | ||||||
|  | 	for i, line := range lines { | ||||||
|  | 		if i == 0 && strings.HasPrefix(line, "// Code generated by") { | ||||||
|  | 			break | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		if match, ok := rexIDPackage.MatchFirst(line); i == 0 && ok { | ||||||
|  | 			pkgname = match.GroupByName("name").Value() | ||||||
|  | 			continue | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		if match, ok := rexIDDef.MatchFirst(line); ok { | ||||||
|  |  | ||||||
|  | 			rfp, err := filepath.Rel(basedir, fn) | ||||||
|  | 			if err != nil { | ||||||
|  | 				return nil, "", err | ||||||
|  | 			} | ||||||
|  |  | ||||||
|  | 			def := IDDef{ | ||||||
|  | 				File:         fn, | ||||||
|  | 				FileRelative: rfp, | ||||||
|  | 				Name:         match.GroupByName("name").Value(), | ||||||
|  | 			} | ||||||
|  |  | ||||||
|  | 			if debugOutput { | ||||||
|  | 				fmt.Printf("Found ID definition { '%s' }\n", def.Name) | ||||||
|  | 			} | ||||||
|  |  | ||||||
|  | 			ids = append(ids, def) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return ids, pkgname, nil | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func fmtIDOutput(cs string, ids []IDDef, pkgname string) string { | ||||||
|  | 	templ := template.Must(template.New("id-generate").Parse(templateIDGenerateText)) | ||||||
|  |  | ||||||
|  | 	buffer := bytes.Buffer{} | ||||||
|  |  | ||||||
|  | 	anyDef := langext.ArrFirstOrNil(ids, func(def IDDef) bool { return def.Name == "AnyID" || def.Name == "AnyId" }) | ||||||
|  |  | ||||||
|  | 	err := templ.Execute(&buffer, langext.H{ | ||||||
|  | 		"PkgName":      pkgname, | ||||||
|  | 		"Checksum":     cs, | ||||||
|  | 		"GoextVersion": goext.GoextVersion, | ||||||
|  | 		"IDs":          ids, | ||||||
|  | 		"AnyDef":       anyDef, | ||||||
|  | 	}) | ||||||
|  | 	if err != nil { | ||||||
|  | 		panic(err) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return buffer.String() | ||||||
|  | } | ||||||
							
								
								
									
										56
									
								
								bfcodegen/id-generate.template
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										56
									
								
								bfcodegen/id-generate.template
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,56 @@ | |||||||
|  | // Code generated by id-generate.go DO NOT EDIT. | ||||||
|  |  | ||||||
|  | package {{.PkgName}} | ||||||
|  |  | ||||||
|  | import "go.mongodb.org/mongo-driver/bson" | ||||||
|  | import "go.mongodb.org/mongo-driver/bson/bsontype" | ||||||
|  | import "go.mongodb.org/mongo-driver/bson/primitive" | ||||||
|  | import "git.blackforestbytes.com/BlackForestBytes/goext/exerr" | ||||||
|  |  | ||||||
|  | const ChecksumIDGenerator = "{{.Checksum}}" // GoExtVersion: {{.GoextVersion}} | ||||||
|  |  | ||||||
|  | {{range .IDs}} | ||||||
|  |  | ||||||
|  | // ================================ {{.Name}} ({{.FileRelative}}) ================================ | ||||||
|  |  | ||||||
|  | func (i {{.Name}}) MarshalBSONValue() (bsontype.Type, []byte, error) { | ||||||
|  | 	if objId, err := primitive.ObjectIDFromHex(string(i)); err == nil { | ||||||
|  | 		return bson.MarshalValue(objId) | ||||||
|  | 	} else { | ||||||
|  | 		return 0, nil, exerr.New(exerr.TypeMarshalEntityID, "Failed to marshal {{.Name}}("+i.String()+") to ObjectId").Str("value", string(i)).Type("type", i).Build() | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (i {{.Name}}) String() string { | ||||||
|  | 	return string(i) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (i {{.Name}}) ObjID() (primitive.ObjectID, error) { | ||||||
|  | 	return primitive.ObjectIDFromHex(string(i)) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (i {{.Name}}) Valid() bool { | ||||||
|  | 	_, err := primitive.ObjectIDFromHex(string(i)) | ||||||
|  | 	return err == nil | ||||||
|  | } | ||||||
|  |  | ||||||
|  | {{if ne $.AnyDef nil}} | ||||||
|  | func (i {{.Name}}) AsAny() {{$.AnyDef.Name}} { | ||||||
|  | 	return {{$.AnyDef.Name}}(i) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (i {{.Name}}) AsAnyPtr() *{{$.AnyDef.Name}} { | ||||||
|  |     v := {{$.AnyDef.Name}}(i) | ||||||
|  | 	return &v | ||||||
|  | } | ||||||
|  | {{end}} | ||||||
|  |  | ||||||
|  | func (i {{.Name}}) IsZero() bool { | ||||||
|  | 	return i == "" | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func New{{.Name}}() {{.Name}} { | ||||||
|  | 	return {{.Name}}(primitive.NewObjectID().Hex()) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | {{end}} | ||||||
							
								
								
									
										52
									
								
								bfcodegen/id-generate_test.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										52
									
								
								bfcodegen/id-generate_test.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,52 @@ | |||||||
|  | package bfcodegen | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	_ "embed" | ||||||
|  | 	"fmt" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/cmdext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/tst" | ||||||
|  | 	"os" | ||||||
|  | 	"path/filepath" | ||||||
|  | 	"testing" | ||||||
|  | 	"time" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | //go:embed _test_example_1.tgz | ||||||
|  | var IDExampleModels1 []byte | ||||||
|  |  | ||||||
|  | func TestGenerateIDSpecs(t *testing.T) { | ||||||
|  |  | ||||||
|  | 	tmpFile := filepath.Join(t.TempDir(), langext.MustHexUUID()+".tgz") | ||||||
|  |  | ||||||
|  | 	tmpDir := filepath.Join(t.TempDir(), langext.MustHexUUID()) | ||||||
|  |  | ||||||
|  | 	err := os.WriteFile(tmpFile, IDExampleModels1, 0o777) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	t.Cleanup(func() { _ = os.Remove(tmpFile) }) | ||||||
|  |  | ||||||
|  | 	err = os.Mkdir(tmpDir, 0o777) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	t.Cleanup(func() { _ = os.RemoveAll(tmpFile) }) | ||||||
|  |  | ||||||
|  | 	_, err = cmdext.Runner("tar").Arg("-xvzf").Arg(tmpFile).Arg("-C").Arg(tmpDir).FailOnExitCode().FailOnTimeout().Timeout(time.Minute).Run() | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	err = GenerateIDSpecs(tmpDir, tmpDir+"/id_gen.go", IDGenOptions{DebugOutput: langext.PTrue}) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	err = GenerateIDSpecs(tmpDir, tmpDir+"/id_gen.go", IDGenOptions{DebugOutput: langext.PTrue}) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	fmt.Println() | ||||||
|  | 	fmt.Println() | ||||||
|  | 	fmt.Println() | ||||||
|  | 	fmt.Println("=====================================================================================================") | ||||||
|  | 	fmt.Println(string(tst.Must(os.ReadFile(tmpDir + "/id_gen.go"))(t))) | ||||||
|  | 	fmt.Println("=====================================================================================================") | ||||||
|  | 	fmt.Println() | ||||||
|  | 	fmt.Println() | ||||||
|  | 	fmt.Println() | ||||||
|  | } | ||||||
| @@ -2,24 +2,31 @@ package cmdext | |||||||
|  |  | ||||||
| import ( | import ( | ||||||
| 	"fmt" | 	"fmt" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
| 	"time" | 	"time" | ||||||
| ) | ) | ||||||
|  |  | ||||||
| type CommandRunner struct { | type CommandRunner struct { | ||||||
| 	program  string | 	program          string | ||||||
| 	args     []string | 	args             []string | ||||||
| 	timeout  *time.Duration | 	timeout          *time.Duration | ||||||
| 	env      []string | 	env              []string | ||||||
| 	listener []CommandListener | 	listener         []CommandListener | ||||||
|  | 	enforceExitCodes *[]int | ||||||
|  | 	enforceNoTimeout bool | ||||||
|  | 	enforceNoStderr  bool | ||||||
| } | } | ||||||
|  |  | ||||||
| func Runner(program string) *CommandRunner { | func Runner(program string) *CommandRunner { | ||||||
| 	return &CommandRunner{ | 	return &CommandRunner{ | ||||||
| 		program:  program, | 		program:          program, | ||||||
| 		args:     make([]string, 0), | 		args:             make([]string, 0), | ||||||
| 		timeout:  nil, | 		timeout:          nil, | ||||||
| 		env:      make([]string, 0), | 		env:              make([]string, 0), | ||||||
| 		listener: make([]CommandListener, 0), | 		listener:         make([]CommandListener, 0), | ||||||
|  | 		enforceExitCodes: nil, | ||||||
|  | 		enforceNoTimeout: false, | ||||||
|  | 		enforceNoStderr:  false, | ||||||
| 	} | 	} | ||||||
| } | } | ||||||
|  |  | ||||||
| @@ -53,6 +60,26 @@ func (r *CommandRunner) Envs(env []string) *CommandRunner { | |||||||
| 	return r | 	return r | ||||||
| } | } | ||||||
|  |  | ||||||
|  | func (r *CommandRunner) EnsureExitcode(arg ...int) *CommandRunner { | ||||||
|  | 	r.enforceExitCodes = langext.Ptr(langext.ForceArray(arg)) | ||||||
|  | 	return r | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (r *CommandRunner) FailOnExitCode() *CommandRunner { | ||||||
|  | 	r.enforceExitCodes = langext.Ptr([]int{0}) | ||||||
|  | 	return r | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (r *CommandRunner) FailOnTimeout() *CommandRunner { | ||||||
|  | 	r.enforceNoTimeout = true | ||||||
|  | 	return r | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (r *CommandRunner) FailOnStderr() *CommandRunner { | ||||||
|  | 	r.enforceNoStderr = true | ||||||
|  | 	return r | ||||||
|  | } | ||||||
|  |  | ||||||
| func (r *CommandRunner) Listen(lstr CommandListener) *CommandRunner { | func (r *CommandRunner) Listen(lstr CommandListener) *CommandRunner { | ||||||
| 	r.listener = append(r.listener, lstr) | 	r.listener = append(r.listener, lstr) | ||||||
| 	return r | 	return r | ||||||
|   | |||||||
| @@ -1,12 +1,18 @@ | |||||||
| package cmdext | package cmdext | ||||||
|  |  | ||||||
| import ( | import ( | ||||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/mathext" | 	"errors" | ||||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/syncext" | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/mathext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/syncext" | ||||||
| 	"os/exec" | 	"os/exec" | ||||||
| 	"time" | 	"time" | ||||||
| ) | ) | ||||||
|  |  | ||||||
|  | var ErrExitCode = errors.New("process exited with an unexpected exitcode") | ||||||
|  | var ErrTimeout = errors.New("process did not exit after the specified timeout") | ||||||
|  | var ErrStderrPrint = errors.New("process did print to stderr stream") | ||||||
|  |  | ||||||
| type CommandResult struct { | type CommandResult struct { | ||||||
| 	StdOut          string | 	StdOut          string | ||||||
| 	StdErr          string | 	StdErr          string | ||||||
| @@ -31,8 +37,9 @@ func run(opt CommandRunner) (CommandResult, error) { | |||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	preader := pipeReader{ | 	preader := pipeReader{ | ||||||
| 		stdout: stdoutPipe, | 		lineBufferSize: langext.Ptr(128 * 1024 * 1024), // 128MB max size of a single line, is hopefully enough.... | ||||||
| 		stderr: stderrPipe, | 		stdout:         stdoutPipe, | ||||||
|  | 		stderr:         stderrPipe, | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	err = cmd.Start() | 	err = cmd.Start() | ||||||
| @@ -47,22 +54,40 @@ func run(opt CommandRunner) (CommandResult, error) { | |||||||
| 		err         error | 		err         error | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
|  | 	stderrFailChan := make(chan bool) | ||||||
|  |  | ||||||
| 	outputChan := make(chan resultObj) | 	outputChan := make(chan resultObj) | ||||||
| 	go func() { | 	go func() { | ||||||
| 		// we need to first fully read the pipes and then call Wait | 		// we need to first fully read the pipes and then call Wait | ||||||
| 		// see https://pkg.go.dev/os/exec#Cmd.StdoutPipe | 		// see https://pkg.go.dev/os/exec#Cmd.StdoutPipe | ||||||
|  |  | ||||||
| 		stdout, stderr, stdcombined, err := preader.Read(opt.listener) | 		listener := make([]CommandListener, 0) | ||||||
|  | 		listener = append(listener, opt.listener...) | ||||||
|  |  | ||||||
|  | 		if opt.enforceNoStderr { | ||||||
|  | 			listener = append(listener, genericCommandListener{ | ||||||
|  | 				_readRawStderr: langext.Ptr(func(v []byte) { | ||||||
|  | 					if len(v) > 0 { | ||||||
|  | 						stderrFailChan <- true | ||||||
|  | 					} | ||||||
|  | 				}), | ||||||
|  | 			}) | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		stdout, stderr, stdcombined, err := preader.Read(listener) | ||||||
| 		if err != nil { | 		if err != nil { | ||||||
| 			outputChan <- resultObj{stdout, stderr, stdcombined, err} | 			outputChan <- resultObj{stdout, stderr, stdcombined, err} | ||||||
|  | 			_ = cmd.Process.Kill() | ||||||
|  | 			return | ||||||
| 		} | 		} | ||||||
|  |  | ||||||
| 		err = cmd.Wait() | 		err = cmd.Wait() | ||||||
| 		if err != nil { | 		if err != nil { | ||||||
| 			outputChan <- resultObj{stdout, stderr, stdcombined, err} | 			outputChan <- resultObj{stdout, stderr, stdcombined, err} | ||||||
|  | 		} else { | ||||||
|  | 			outputChan <- resultObj{stdout, stderr, stdcombined, nil} | ||||||
| 		} | 		} | ||||||
|  |  | ||||||
| 		outputChan <- resultObj{stdout, stderr, stdcombined, nil} |  | ||||||
| 	}() | 	}() | ||||||
|  |  | ||||||
| 	var timeoutChan <-chan time.Time = make(chan time.Time, 1) | 	var timeoutChan <-chan time.Time = make(chan time.Time, 1) | ||||||
| @@ -81,49 +106,91 @@ func run(opt CommandRunner) (CommandResult, error) { | |||||||
| 		if fallback, ok := syncext.ReadChannelWithTimeout(outputChan, mathext.Min(32*time.Millisecond, *opt.timeout)); ok { | 		if fallback, ok := syncext.ReadChannelWithTimeout(outputChan, mathext.Min(32*time.Millisecond, *opt.timeout)); ok { | ||||||
| 			// most of the time the cmd.Process.Kill() should also ahve finished the pipereader | 			// most of the time the cmd.Process.Kill() should also ahve finished the pipereader | ||||||
| 			// and we can at least return the already collected stdout, stderr, etc | 			// and we can at least return the already collected stdout, stderr, etc | ||||||
| 			return CommandResult{ | 			res := CommandResult{ | ||||||
| 				StdOut:          fallback.stdout, | 				StdOut:          fallback.stdout, | ||||||
| 				StdErr:          fallback.stderr, | 				StdErr:          fallback.stderr, | ||||||
| 				StdCombined:     fallback.stdcombined, | 				StdCombined:     fallback.stdcombined, | ||||||
| 				ExitCode:        -1, | 				ExitCode:        -1, | ||||||
| 				CommandTimedOut: true, | 				CommandTimedOut: true, | ||||||
| 			}, nil | 			} | ||||||
|  | 			if opt.enforceNoTimeout { | ||||||
|  | 				return res, ErrTimeout | ||||||
|  | 			} | ||||||
|  | 			return res, nil | ||||||
| 		} else { | 		} else { | ||||||
| 			return CommandResult{ | 			res := CommandResult{ | ||||||
| 				StdOut:          "", | 				StdOut:          "", | ||||||
| 				StdErr:          "", | 				StdErr:          "", | ||||||
| 				StdCombined:     "", | 				StdCombined:     "", | ||||||
| 				ExitCode:        -1, | 				ExitCode:        -1, | ||||||
| 				CommandTimedOut: true, | 				CommandTimedOut: true, | ||||||
| 			}, nil | 			} | ||||||
|  | 			if opt.enforceNoTimeout { | ||||||
|  | 				return res, ErrTimeout | ||||||
|  | 			} | ||||||
|  | 			return res, nil | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 	case <-stderrFailChan: | ||||||
|  | 		_ = cmd.Process.Kill() | ||||||
|  |  | ||||||
|  | 		if fallback, ok := syncext.ReadChannelWithTimeout(outputChan, 32*time.Millisecond); ok { | ||||||
|  | 			// most of the time the cmd.Process.Kill() should also have finished the pipereader | ||||||
|  | 			// and we can at least return the already collected stdout, stderr, etc | ||||||
|  | 			res := CommandResult{ | ||||||
|  | 				StdOut:          fallback.stdout, | ||||||
|  | 				StdErr:          fallback.stderr, | ||||||
|  | 				StdCombined:     fallback.stdcombined, | ||||||
|  | 				ExitCode:        -1, | ||||||
|  | 				CommandTimedOut: false, | ||||||
|  | 			} | ||||||
|  | 			return res, ErrStderrPrint | ||||||
|  | 		} else { | ||||||
|  | 			res := CommandResult{ | ||||||
|  | 				StdOut:          "", | ||||||
|  | 				StdErr:          "", | ||||||
|  | 				StdCombined:     "", | ||||||
|  | 				ExitCode:        -1, | ||||||
|  | 				CommandTimedOut: false, | ||||||
|  | 			} | ||||||
|  | 			return res, ErrStderrPrint | ||||||
| 		} | 		} | ||||||
|  |  | ||||||
| 	case outobj := <-outputChan: | 	case outobj := <-outputChan: | ||||||
| 		if exiterr, ok := outobj.err.(*exec.ExitError); ok { | 		var exiterr *exec.ExitError | ||||||
|  | 		if errors.As(outobj.err, &exiterr) { | ||||||
| 			excode := exiterr.ExitCode() | 			excode := exiterr.ExitCode() | ||||||
| 			for _, lstr := range opt.listener { | 			for _, lstr := range opt.listener { | ||||||
| 				lstr.Finished(excode) | 				lstr.Finished(excode) | ||||||
| 			} | 			} | ||||||
| 			return CommandResult{ | 			res := CommandResult{ | ||||||
| 				StdOut:          outobj.stdout, | 				StdOut:          outobj.stdout, | ||||||
| 				StdErr:          outobj.stderr, | 				StdErr:          outobj.stderr, | ||||||
| 				StdCombined:     outobj.stdcombined, | 				StdCombined:     outobj.stdcombined, | ||||||
| 				ExitCode:        excode, | 				ExitCode:        excode, | ||||||
| 				CommandTimedOut: false, | 				CommandTimedOut: false, | ||||||
| 			}, nil | 			} | ||||||
|  | 			if opt.enforceExitCodes != nil && !langext.InArray(excode, *opt.enforceExitCodes) { | ||||||
|  | 				return res, ErrExitCode | ||||||
|  | 			} | ||||||
|  | 			return res, nil | ||||||
| 		} else if err != nil { | 		} else if err != nil { | ||||||
| 			return CommandResult{}, err | 			return CommandResult{}, err | ||||||
| 		} else { | 		} else { | ||||||
| 			for _, lstr := range opt.listener { | 			for _, lstr := range opt.listener { | ||||||
| 				lstr.Finished(0) | 				lstr.Finished(0) | ||||||
| 			} | 			} | ||||||
| 			return CommandResult{ | 			res := CommandResult{ | ||||||
| 				StdOut:          outobj.stdout, | 				StdOut:          outobj.stdout, | ||||||
| 				StdErr:          outobj.stderr, | 				StdErr:          outobj.stderr, | ||||||
| 				StdCombined:     outobj.stdcombined, | 				StdCombined:     outobj.stdcombined, | ||||||
| 				ExitCode:        0, | 				ExitCode:        0, | ||||||
| 				CommandTimedOut: false, | 				CommandTimedOut: false, | ||||||
| 			}, nil | 			} | ||||||
|  | 			if opt.enforceExitCodes != nil && !langext.InArray(0, *opt.enforceExitCodes) { | ||||||
|  | 				return res, ErrExitCode | ||||||
|  | 			} | ||||||
|  | 			return res, nil | ||||||
| 		} | 		} | ||||||
| 	} | 	} | ||||||
| } | } | ||||||
|   | |||||||
| @@ -1,6 +1,7 @@ | |||||||
| package cmdext | package cmdext | ||||||
|  |  | ||||||
| import ( | import ( | ||||||
|  | 	"errors" | ||||||
| 	"fmt" | 	"fmt" | ||||||
| 	"testing" | 	"testing" | ||||||
| 	"time" | 	"time" | ||||||
| @@ -12,6 +13,12 @@ func TestStdout(t *testing.T) { | |||||||
| 	if err != nil { | 	if err != nil { | ||||||
| 		t.Errorf("%v", err) | 		t.Errorf("%v", err) | ||||||
| 	} | 	} | ||||||
|  | 	if res1.CommandTimedOut { | ||||||
|  | 		t.Errorf("Timeout") | ||||||
|  | 	} | ||||||
|  | 	if res1.ExitCode != 0 { | ||||||
|  | 		t.Errorf("res1.ExitCode == %v", res1.ExitCode) | ||||||
|  | 	} | ||||||
| 	if res1.StdErr != "" { | 	if res1.StdErr != "" { | ||||||
| 		t.Errorf("res1.StdErr == '%v'", res1.StdErr) | 		t.Errorf("res1.StdErr == '%v'", res1.StdErr) | ||||||
| 	} | 	} | ||||||
| @@ -26,10 +33,16 @@ func TestStdout(t *testing.T) { | |||||||
|  |  | ||||||
| func TestStderr(t *testing.T) { | func TestStderr(t *testing.T) { | ||||||
|  |  | ||||||
| 	res1, err := Runner("python").Arg("-c").Arg("import sys; print(\"error\", file=sys.stderr, end='')").Run() | 	res1, err := Runner("python3").Arg("-c").Arg("import sys; print(\"error\", file=sys.stderr, end='')").Run() | ||||||
| 	if err != nil { | 	if err != nil { | ||||||
| 		t.Errorf("%v", err) | 		t.Errorf("%v", err) | ||||||
| 	} | 	} | ||||||
|  | 	if res1.CommandTimedOut { | ||||||
|  | 		t.Errorf("Timeout") | ||||||
|  | 	} | ||||||
|  | 	if res1.ExitCode != 0 { | ||||||
|  | 		t.Errorf("res1.ExitCode == %v", res1.ExitCode) | ||||||
|  | 	} | ||||||
| 	if res1.StdErr != "error" { | 	if res1.StdErr != "error" { | ||||||
| 		t.Errorf("res1.StdErr == '%v'", res1.StdErr) | 		t.Errorf("res1.StdErr == '%v'", res1.StdErr) | ||||||
| 	} | 	} | ||||||
| @@ -43,13 +56,19 @@ func TestStderr(t *testing.T) { | |||||||
| } | } | ||||||
|  |  | ||||||
| func TestStdcombined(t *testing.T) { | func TestStdcombined(t *testing.T) { | ||||||
| 	res1, err := Runner("python"). | 	res1, err := Runner("python3"). | ||||||
| 		Arg("-c"). | 		Arg("-c"). | ||||||
| 		Arg("import sys; import time; print(\"1\", file=sys.stderr, flush=True); time.sleep(0.1); print(\"2\", file=sys.stdout, flush=True); time.sleep(0.1); print(\"3\", file=sys.stderr, flush=True)"). | 		Arg("import sys; import time; print(\"1\", file=sys.stderr, flush=True); time.sleep(0.1); print(\"2\", file=sys.stdout, flush=True); time.sleep(0.1); print(\"3\", file=sys.stderr, flush=True)"). | ||||||
| 		Run() | 		Run() | ||||||
| 	if err != nil { | 	if err != nil { | ||||||
| 		t.Errorf("%v", err) | 		t.Errorf("%v", err) | ||||||
| 	} | 	} | ||||||
|  | 	if res1.CommandTimedOut { | ||||||
|  | 		t.Errorf("Timeout") | ||||||
|  | 	} | ||||||
|  | 	if res1.ExitCode != 0 { | ||||||
|  | 		t.Errorf("res1.ExitCode == %v", res1.ExitCode) | ||||||
|  | 	} | ||||||
| 	if res1.StdErr != "1\n3\n" { | 	if res1.StdErr != "1\n3\n" { | ||||||
| 		t.Errorf("res1.StdErr == '%v'", res1.StdErr) | 		t.Errorf("res1.StdErr == '%v'", res1.StdErr) | ||||||
| 	} | 	} | ||||||
| @@ -63,7 +82,7 @@ func TestStdcombined(t *testing.T) { | |||||||
| } | } | ||||||
|  |  | ||||||
| func TestPartialRead(t *testing.T) { | func TestPartialRead(t *testing.T) { | ||||||
| 	res1, err := Runner("python"). | 	res1, err := Runner("python3"). | ||||||
| 		Arg("-c"). | 		Arg("-c"). | ||||||
| 		Arg("import sys; import time; print(\"first message\", flush=True); time.sleep(5); print(\"cant see me\", flush=True);"). | 		Arg("import sys; import time; print(\"first message\", flush=True); time.sleep(5); print(\"cant see me\", flush=True);"). | ||||||
| 		Timeout(100 * time.Millisecond). | 		Timeout(100 * time.Millisecond). | ||||||
| @@ -87,7 +106,7 @@ func TestPartialRead(t *testing.T) { | |||||||
| } | } | ||||||
|  |  | ||||||
| func TestPartialReadStderr(t *testing.T) { | func TestPartialReadStderr(t *testing.T) { | ||||||
| 	res1, err := Runner("python"). | 	res1, err := Runner("python3"). | ||||||
| 		Arg("-c"). | 		Arg("-c"). | ||||||
| 		Arg("import sys; import time; print(\"first message\", file=sys.stderr, flush=True); time.sleep(5); print(\"cant see me\", file=sys.stderr, flush=True);"). | 		Arg("import sys; import time; print(\"first message\", file=sys.stderr, flush=True); time.sleep(5); print(\"cant see me\", file=sys.stderr, flush=True);"). | ||||||
| 		Timeout(100 * time.Millisecond). | 		Timeout(100 * time.Millisecond). | ||||||
| @@ -112,10 +131,16 @@ func TestPartialReadStderr(t *testing.T) { | |||||||
|  |  | ||||||
| func TestReadUnflushedStdout(t *testing.T) { | func TestReadUnflushedStdout(t *testing.T) { | ||||||
|  |  | ||||||
| 	res1, err := Runner("python").Arg("-c").Arg("import sys; print(\"message101\", file=sys.stdout, end='')").Run() | 	res1, err := Runner("python3").Arg("-c").Arg("import sys; print(\"message101\", file=sys.stdout, end='')").Run() | ||||||
| 	if err != nil { | 	if err != nil { | ||||||
| 		t.Errorf("%v", err) | 		t.Errorf("%v", err) | ||||||
| 	} | 	} | ||||||
|  | 	if res1.CommandTimedOut { | ||||||
|  | 		t.Errorf("Timeout") | ||||||
|  | 	} | ||||||
|  | 	if res1.ExitCode != 0 { | ||||||
|  | 		t.Errorf("res1.ExitCode == %v", res1.ExitCode) | ||||||
|  | 	} | ||||||
| 	if res1.StdErr != "" { | 	if res1.StdErr != "" { | ||||||
| 		t.Errorf("res1.StdErr == '%v'", res1.StdErr) | 		t.Errorf("res1.StdErr == '%v'", res1.StdErr) | ||||||
| 	} | 	} | ||||||
| @@ -130,10 +155,16 @@ func TestReadUnflushedStdout(t *testing.T) { | |||||||
|  |  | ||||||
| func TestReadUnflushedStderr(t *testing.T) { | func TestReadUnflushedStderr(t *testing.T) { | ||||||
|  |  | ||||||
| 	res1, err := Runner("python").Arg("-c").Arg("import sys; print(\"message101\", file=sys.stderr, end='')").Run() | 	res1, err := Runner("python3").Arg("-c").Arg("import sys; print(\"message101\", file=sys.stderr, end='')").Run() | ||||||
| 	if err != nil { | 	if err != nil { | ||||||
| 		t.Errorf("%v", err) | 		t.Errorf("%v", err) | ||||||
| 	} | 	} | ||||||
|  | 	if res1.CommandTimedOut { | ||||||
|  | 		t.Errorf("Timeout") | ||||||
|  | 	} | ||||||
|  | 	if res1.ExitCode != 0 { | ||||||
|  | 		t.Errorf("res1.ExitCode == %v", res1.ExitCode) | ||||||
|  | 	} | ||||||
| 	if res1.StdErr != "message101" { | 	if res1.StdErr != "message101" { | ||||||
| 		t.Errorf("res1.StdErr == '%v'", res1.StdErr) | 		t.Errorf("res1.StdErr == '%v'", res1.StdErr) | ||||||
| 	} | 	} | ||||||
| @@ -149,7 +180,7 @@ func TestReadUnflushedStderr(t *testing.T) { | |||||||
| func TestPartialReadUnflushed(t *testing.T) { | func TestPartialReadUnflushed(t *testing.T) { | ||||||
| 	t.SkipNow() | 	t.SkipNow() | ||||||
|  |  | ||||||
| 	res1, err := Runner("python"). | 	res1, err := Runner("python3"). | ||||||
| 		Arg("-c"). | 		Arg("-c"). | ||||||
| 		Arg("import sys; import time; print(\"first message\", end=''); time.sleep(5); print(\"cant see me\", end='');"). | 		Arg("import sys; import time; print(\"first message\", end=''); time.sleep(5); print(\"cant see me\", end='');"). | ||||||
| 		Timeout(100 * time.Millisecond). | 		Timeout(100 * time.Millisecond). | ||||||
| @@ -175,7 +206,7 @@ func TestPartialReadUnflushed(t *testing.T) { | |||||||
| func TestPartialReadUnflushedStderr(t *testing.T) { | func TestPartialReadUnflushedStderr(t *testing.T) { | ||||||
| 	t.SkipNow() | 	t.SkipNow() | ||||||
|  |  | ||||||
| 	res1, err := Runner("python"). | 	res1, err := Runner("python3"). | ||||||
| 		Arg("-c"). | 		Arg("-c"). | ||||||
| 		Arg("import sys; import time; print(\"first message\", file=sys.stderr, end=''); time.sleep(5); print(\"cant see me\", file=sys.stderr, end='');"). | 		Arg("import sys; import time; print(\"first message\", file=sys.stderr, end=''); time.sleep(5); print(\"cant see me\", file=sys.stderr, end='');"). | ||||||
| 		Timeout(100 * time.Millisecond). | 		Timeout(100 * time.Millisecond). | ||||||
| @@ -200,7 +231,7 @@ func TestPartialReadUnflushedStderr(t *testing.T) { | |||||||
|  |  | ||||||
| func TestListener(t *testing.T) { | func TestListener(t *testing.T) { | ||||||
|  |  | ||||||
| 	_, err := Runner("python"). | 	res1, err := Runner("python3"). | ||||||
| 		Arg("-c"). | 		Arg("-c"). | ||||||
| 		Arg("import sys;" + | 		Arg("import sys;" + | ||||||
| 			"import time;" + | 			"import time;" + | ||||||
| @@ -223,4 +254,95 @@ func TestListener(t *testing.T) { | |||||||
| 	if err != nil { | 	if err != nil { | ||||||
| 		panic(err) | 		panic(err) | ||||||
| 	} | 	} | ||||||
|  | 	if res1.CommandTimedOut { | ||||||
|  | 		t.Errorf("Timeout") | ||||||
|  | 	} | ||||||
|  | 	if res1.ExitCode != 0 { | ||||||
|  | 		t.Errorf("res1.ExitCode == %v", res1.ExitCode) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestLongStdout(t *testing.T) { | ||||||
|  |  | ||||||
|  | 	res1, err := Runner("python3"). | ||||||
|  | 		Arg("-c"). | ||||||
|  | 		Arg("import sys; import time; print(\"X\" * 125001 + \"\\n\"); print(\"Y\" * 125001 + \"\\n\"); print(\"Z\" * 125001 + \"\\n\");"). | ||||||
|  | 		Timeout(5000 * time.Millisecond). | ||||||
|  | 		Run() | ||||||
|  | 	if err != nil { | ||||||
|  | 		t.Errorf("%v", err) | ||||||
|  | 	} | ||||||
|  | 	if res1.CommandTimedOut { | ||||||
|  | 		t.Errorf("Timeout") | ||||||
|  | 	} | ||||||
|  | 	if res1.ExitCode != 0 { | ||||||
|  | 		t.Errorf("res1.ExitCode == %v", res1.ExitCode) | ||||||
|  | 	} | ||||||
|  | 	if res1.StdErr != "" { | ||||||
|  | 		t.Errorf("res1.StdErr == '%v'", res1.StdErr) | ||||||
|  | 	} | ||||||
|  | 	if len(res1.StdOut) != 375009 { | ||||||
|  | 		t.Errorf("len(res1.StdOut) == '%v'", len(res1.StdOut)) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestFailOnTimeout(t *testing.T) { | ||||||
|  |  | ||||||
|  | 	_, err := Runner("sleep").Arg("2").Timeout(200 * time.Millisecond).FailOnTimeout().Run() | ||||||
|  | 	if !errors.Is(err, ErrTimeout) { | ||||||
|  | 		t.Errorf("wrong err := %v", err) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestFailOnStderr(t *testing.T) { | ||||||
|  |  | ||||||
|  | 	res1, err := Runner("python3").Arg("-c").Arg("import sys; print(\"error\", file=sys.stderr, end='')").FailOnStderr().Run() | ||||||
|  | 	if err == nil { | ||||||
|  | 		t.Errorf("no err") | ||||||
|  | 	} | ||||||
|  | 	if res1.CommandTimedOut { | ||||||
|  | 		t.Errorf("Timeout") | ||||||
|  | 	} | ||||||
|  | 	if res1.ExitCode != -1 { | ||||||
|  | 		t.Errorf("res1.ExitCode == %v", res1.ExitCode) | ||||||
|  | 	} | ||||||
|  | 	if res1.StdErr != "error" { | ||||||
|  | 		t.Errorf("res1.StdErr == '%v'", res1.StdErr) | ||||||
|  | 	} | ||||||
|  | 	if res1.StdOut != "" { | ||||||
|  | 		t.Errorf("res1.StdOut == '%v'", res1.StdOut) | ||||||
|  | 	} | ||||||
|  | 	if res1.StdCombined != "error\n" { | ||||||
|  | 		t.Errorf("res1.StdCombined == '%v'", res1.StdCombined) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestFailOnExitcode(t *testing.T) { | ||||||
|  |  | ||||||
|  | 	_, err := Runner("false").Timeout(200 * time.Millisecond).FailOnExitCode().Run() | ||||||
|  | 	if !errors.Is(err, ErrExitCode) { | ||||||
|  | 		t.Errorf("wrong err := %v", err) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestEnsureExitcode1(t *testing.T) { | ||||||
|  |  | ||||||
|  | 	_, err := Runner("false").Timeout(200 * time.Millisecond).EnsureExitcode(1).Run() | ||||||
|  | 	if err != nil { | ||||||
|  | 		t.Errorf("wrong err := %v", err) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestEnsureExitcode2(t *testing.T) { | ||||||
|  |  | ||||||
|  | 	_, err := Runner("false").Timeout(200*time.Millisecond).EnsureExitcode(0, 2, 3).Run() | ||||||
|  | 	if err != ErrExitCode { | ||||||
|  | 		t.Errorf("wrong err := %v", err) | ||||||
|  | 	} | ||||||
|  |  | ||||||
| } | } | ||||||
|   | |||||||
| @@ -2,14 +2,15 @@ package cmdext | |||||||
|  |  | ||||||
| import ( | import ( | ||||||
| 	"bufio" | 	"bufio" | ||||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/syncext" | 	"git.blackforestbytes.com/BlackForestBytes/goext/syncext" | ||||||
| 	"io" | 	"io" | ||||||
| 	"sync" | 	"sync" | ||||||
| ) | ) | ||||||
|  |  | ||||||
| type pipeReader struct { | type pipeReader struct { | ||||||
| 	stdout io.ReadCloser | 	lineBufferSize *int | ||||||
| 	stderr io.ReadCloser | 	stdout         io.ReadCloser | ||||||
|  | 	stderr         io.ReadCloser | ||||||
| } | } | ||||||
|  |  | ||||||
| // Read ready stdout and stdin until finished | // Read ready stdout and stdin until finished | ||||||
| @@ -31,9 +32,8 @@ func (pr *pipeReader) Read(listener []CommandListener) (string, string, string, | |||||||
| 	stdout := "" | 	stdout := "" | ||||||
| 	go func() { | 	go func() { | ||||||
| 		buf := make([]byte, 128) | 		buf := make([]byte, 128) | ||||||
| 		for true { | 		for { | ||||||
| 			n, out := pr.stdout.Read(buf) | 			n, err := pr.stdout.Read(buf) | ||||||
|  |  | ||||||
| 			if n > 0 { | 			if n > 0 { | ||||||
| 				txt := string(buf[:n]) | 				txt := string(buf[:n]) | ||||||
| 				stdout += txt | 				stdout += txt | ||||||
| @@ -42,11 +42,11 @@ func (pr *pipeReader) Read(listener []CommandListener) (string, string, string, | |||||||
| 					lstr.ReadRawStdout(buf[:n]) | 					lstr.ReadRawStdout(buf[:n]) | ||||||
| 				} | 				} | ||||||
| 			} | 			} | ||||||
| 			if out == io.EOF { | 			if err == io.EOF { | ||||||
| 				break | 				break | ||||||
| 			} | 			} | ||||||
| 			if out != nil { | 			if err != nil { | ||||||
| 				errch <- out | 				errch <- err | ||||||
| 				break | 				break | ||||||
| 			} | 			} | ||||||
| 		} | 		} | ||||||
| @@ -61,7 +61,7 @@ func (pr *pipeReader) Read(listener []CommandListener) (string, string, string, | |||||||
| 	stderr := "" | 	stderr := "" | ||||||
| 	go func() { | 	go func() { | ||||||
| 		buf := make([]byte, 128) | 		buf := make([]byte, 128) | ||||||
| 		for true { | 		for { | ||||||
| 			n, err := pr.stderr.Read(buf) | 			n, err := pr.stderr.Read(buf) | ||||||
|  |  | ||||||
| 			if n > 0 { | 			if n > 0 { | ||||||
| @@ -91,6 +91,9 @@ func (pr *pipeReader) Read(listener []CommandListener) (string, string, string, | |||||||
| 	wg.Add(1) | 	wg.Add(1) | ||||||
| 	go func() { | 	go func() { | ||||||
| 		scanner := bufio.NewScanner(stdoutBufferReader) | 		scanner := bufio.NewScanner(stdoutBufferReader) | ||||||
|  | 		if pr.lineBufferSize != nil { | ||||||
|  | 			scanner.Buffer([]byte{}, *pr.lineBufferSize) | ||||||
|  | 		} | ||||||
| 		for scanner.Scan() { | 		for scanner.Scan() { | ||||||
| 			txt := scanner.Text() | 			txt := scanner.Text() | ||||||
| 			for _, lstr := range listener { | 			for _, lstr := range listener { | ||||||
| @@ -98,6 +101,9 @@ func (pr *pipeReader) Read(listener []CommandListener) (string, string, string, | |||||||
| 			} | 			} | ||||||
| 			combch <- combevt{txt, false} | 			combch <- combevt{txt, false} | ||||||
| 		} | 		} | ||||||
|  | 		if err := scanner.Err(); err != nil { | ||||||
|  | 			errch <- err | ||||||
|  | 		} | ||||||
| 		combch <- combevt{"", true} | 		combch <- combevt{"", true} | ||||||
| 		wg.Done() | 		wg.Done() | ||||||
| 	}() | 	}() | ||||||
| @@ -107,6 +113,9 @@ func (pr *pipeReader) Read(listener []CommandListener) (string, string, string, | |||||||
| 	wg.Add(1) | 	wg.Add(1) | ||||||
| 	go func() { | 	go func() { | ||||||
| 		scanner := bufio.NewScanner(stderrBufferReader) | 		scanner := bufio.NewScanner(stderrBufferReader) | ||||||
|  | 		if pr.lineBufferSize != nil { | ||||||
|  | 			scanner.Buffer([]byte{}, *pr.lineBufferSize) | ||||||
|  | 		} | ||||||
| 		for scanner.Scan() { | 		for scanner.Scan() { | ||||||
| 			txt := scanner.Text() | 			txt := scanner.Text() | ||||||
| 			for _, lstr := range listener { | 			for _, lstr := range listener { | ||||||
| @@ -114,6 +123,9 @@ func (pr *pipeReader) Read(listener []CommandListener) (string, string, string, | |||||||
| 			} | 			} | ||||||
| 			combch <- combevt{txt, false} | 			combch <- combevt{txt, false} | ||||||
| 		} | 		} | ||||||
|  | 		if err := scanner.Err(); err != nil { | ||||||
|  | 			errch <- err | ||||||
|  | 		} | ||||||
| 		combch <- combevt{"", true} | 		combch <- combevt{"", true} | ||||||
| 		wg.Done() | 		wg.Done() | ||||||
| 	}() | 	}() | ||||||
|   | |||||||
| @@ -3,11 +3,12 @@ package confext | |||||||
| import ( | import ( | ||||||
| 	"errors" | 	"errors" | ||||||
| 	"fmt" | 	"fmt" | ||||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/timeext" | 	"git.blackforestbytes.com/BlackForestBytes/goext/timeext" | ||||||
| 	"math/bits" | 	"math/bits" | ||||||
| 	"os" | 	"os" | ||||||
| 	"reflect" | 	"reflect" | ||||||
| 	"strconv" | 	"strconv" | ||||||
|  | 	"strings" | ||||||
| 	"time" | 	"time" | ||||||
| ) | ) | ||||||
|  |  | ||||||
| @@ -22,10 +23,10 @@ import ( | |||||||
| // | // | ||||||
| // sub-structs are recursively parsed (if they have an env tag) and the env-variable keys are delimited by the delim parameter | // sub-structs are recursively parsed (if they have an env tag) and the env-variable keys are delimited by the delim parameter | ||||||
| // sub-structs with `env:""` are also parsed, but the delimited is skipped (they are handled as if they were one level higher) | // sub-structs with `env:""` are also parsed, but the delimited is skipped (they are handled as if they were one level higher) | ||||||
| func ApplyEnvOverrides[T any](c *T, delim string) error { | func ApplyEnvOverrides[T any](prefix string, c *T, delim string) error { | ||||||
| 	rval := reflect.ValueOf(c).Elem() | 	rval := reflect.ValueOf(c).Elem() | ||||||
|  |  | ||||||
| 	return processEnvOverrides(rval, delim, "") | 	return processEnvOverrides(rval, delim, prefix) | ||||||
| } | } | ||||||
|  |  | ||||||
| func processEnvOverrides(rval reflect.Value, delim string, prefix string) error { | func processEnvOverrides(rval reflect.Value, delim string, prefix string) error { | ||||||
| @@ -40,12 +41,12 @@ func processEnvOverrides(rval reflect.Value, delim string, prefix string) error | |||||||
| 			continue | 			continue | ||||||
| 		} | 		} | ||||||
|  |  | ||||||
| 		if rvfield.Kind() == reflect.Struct { | 		envkey, found := rsfield.Tag.Lookup("env") | ||||||
|  | 		if !found || envkey == "-" { | ||||||
|  | 			continue | ||||||
|  | 		} | ||||||
|  |  | ||||||
| 			envkey, found := rsfield.Tag.Lookup("env") | 		if rvfield.Kind() == reflect.Struct && rvfield.Type() != reflect.TypeOf(time.UnixMilli(0)) { | ||||||
| 			if !found || envkey == "-" { |  | ||||||
| 				continue |  | ||||||
| 			} |  | ||||||
|  |  | ||||||
| 			subPrefix := prefix | 			subPrefix := prefix | ||||||
| 			if envkey != "" { | 			if envkey != "" { | ||||||
| @@ -56,10 +57,7 @@ func processEnvOverrides(rval reflect.Value, delim string, prefix string) error | |||||||
| 			if err != nil { | 			if err != nil { | ||||||
| 				return err | 				return err | ||||||
| 			} | 			} | ||||||
| 		} |  | ||||||
|  |  | ||||||
| 		envkey := rsfield.Tag.Get("env") |  | ||||||
| 		if envkey == "" || envkey == "-" { |  | ||||||
| 			continue | 			continue | ||||||
| 		} | 		} | ||||||
|  |  | ||||||
| @@ -70,103 +68,128 @@ func processEnvOverrides(rval reflect.Value, delim string, prefix string) error | |||||||
| 			continue | 			continue | ||||||
| 		} | 		} | ||||||
|  |  | ||||||
| 		if rvfield.Type() == reflect.TypeOf("") { | 		if rvfield.Type().Kind() == reflect.Pointer { | ||||||
|  |  | ||||||
| 			rvfield.Set(reflect.ValueOf(envval)) | 			newval, err := parseEnvToValue(envval, fullEnvKey, rvfield.Type().Elem()) | ||||||
|  | 			if err != nil { | ||||||
|  | 				return err | ||||||
|  | 			} | ||||||
|  |  | ||||||
|  | 			// converts reflect.Value to pointer | ||||||
|  | 			ptrval := reflect.New(rvfield.Type().Elem()) | ||||||
|  | 			ptrval.Elem().Set(newval) | ||||||
|  |  | ||||||
|  | 			rvfield.Set(ptrval) | ||||||
|  |  | ||||||
| 			fmt.Printf("[CONF] Overwrite config '%s' with '%s'\n", fullEnvKey, envval) | 			fmt.Printf("[CONF] Overwrite config '%s' with '%s'\n", fullEnvKey, envval) | ||||||
|  |  | ||||||
| 		} else if rvfield.Type() == reflect.TypeOf(int(0)) { |  | ||||||
|  |  | ||||||
| 			envint, err := strconv.ParseInt(envval, 10, bits.UintSize) |  | ||||||
| 			if err != nil { |  | ||||||
| 				return errors.New(fmt.Sprintf("Failed to parse env-config variable '%s' to int (value := '%s')", fullEnvKey, envval)) |  | ||||||
| 			} |  | ||||||
|  |  | ||||||
| 			rvfield.Set(reflect.ValueOf(int(envint))) |  | ||||||
|  |  | ||||||
| 			fmt.Printf("[CONF] Overwrite config '%s' with '%s'\n", fullEnvKey, envval) |  | ||||||
|  |  | ||||||
| 		} else if rvfield.Type() == reflect.TypeOf(int64(0)) { |  | ||||||
|  |  | ||||||
| 			envint, err := strconv.ParseInt(envval, 10, 64) |  | ||||||
| 			if err != nil { |  | ||||||
| 				return errors.New(fmt.Sprintf("Failed to parse env-config variable '%s' to int64 (value := '%s')", fullEnvKey, envval)) |  | ||||||
| 			} |  | ||||||
|  |  | ||||||
| 			rvfield.Set(reflect.ValueOf(int64(envint))) |  | ||||||
|  |  | ||||||
| 			fmt.Printf("[CONF] Overwrite config '%s' with '%s'\n", fullEnvKey, envval) |  | ||||||
|  |  | ||||||
| 		} else if rvfield.Type() == reflect.TypeOf(int32(0)) { |  | ||||||
|  |  | ||||||
| 			envint, err := strconv.ParseInt(envval, 10, 32) |  | ||||||
| 			if err != nil { |  | ||||||
| 				return errors.New(fmt.Sprintf("Failed to parse env-config variable '%s' to int32 (value := '%s')", fullEnvKey, envval)) |  | ||||||
| 			} |  | ||||||
|  |  | ||||||
| 			rvfield.Set(reflect.ValueOf(int32(envint))) |  | ||||||
|  |  | ||||||
| 			fmt.Printf("[CONF] Overwrite config '%s' with '%s'\n", fullEnvKey, envval) |  | ||||||
|  |  | ||||||
| 		} else if rvfield.Type() == reflect.TypeOf(int8(0)) { |  | ||||||
|  |  | ||||||
| 			envint, err := strconv.ParseInt(envval, 10, 8) |  | ||||||
| 			if err != nil { |  | ||||||
| 				return errors.New(fmt.Sprintf("Failed to parse env-config variable '%s' to int32 (value := '%s')", fullEnvKey, envval)) |  | ||||||
| 			} |  | ||||||
|  |  | ||||||
| 			rvfield.Set(reflect.ValueOf(int8(envint))) |  | ||||||
|  |  | ||||||
| 			fmt.Printf("[CONF] Overwrite config '%s' with '%s'\n", fullEnvKey, envval) |  | ||||||
|  |  | ||||||
| 		} else if rvfield.Type() == reflect.TypeOf(time.Duration(0)) { |  | ||||||
|  |  | ||||||
| 			dur, err := timeext.ParseDurationShortString(envval) |  | ||||||
| 			if err != nil { |  | ||||||
| 				return errors.New(fmt.Sprintf("Failed to parse env-config variable '%s' to duration (value := '%s')", fullEnvKey, envval)) |  | ||||||
| 			} |  | ||||||
|  |  | ||||||
| 			rvfield.Set(reflect.ValueOf(dur)) |  | ||||||
|  |  | ||||||
| 			fmt.Printf("[CONF] Overwrite config '%s' with '%s'\n", fullEnvKey, dur.String()) |  | ||||||
|  |  | ||||||
| 		} else if rvfield.Type() == reflect.TypeOf(time.UnixMilli(0)) { |  | ||||||
|  |  | ||||||
| 			tim, err := time.Parse(time.RFC3339Nano, envval) |  | ||||||
| 			if err != nil { |  | ||||||
| 				return errors.New(fmt.Sprintf("Failed to parse env-config variable '%s' to time.time (value := '%s')", fullEnvKey, envval)) |  | ||||||
| 			} |  | ||||||
|  |  | ||||||
| 			rvfield.Set(reflect.ValueOf(tim)) |  | ||||||
|  |  | ||||||
| 			fmt.Printf("[CONF] Overwrite config '%s' with '%s'\n", fullEnvKey, tim.String()) |  | ||||||
|  |  | ||||||
| 		} else if rvfield.Type().ConvertibleTo(reflect.TypeOf(int(0))) { |  | ||||||
|  |  | ||||||
| 			envint, err := strconv.ParseInt(envval, 10, 8) |  | ||||||
| 			if err != nil { |  | ||||||
| 				return errors.New(fmt.Sprintf("Failed to parse env-config variable '%s' to <%s, ,int> (value := '%s')", rvfield.Type().Name(), fullEnvKey, envval)) |  | ||||||
| 			} |  | ||||||
|  |  | ||||||
| 			envcvl := reflect.ValueOf(envint).Convert(rvfield.Type()) |  | ||||||
|  |  | ||||||
| 			rvfield.Set(envcvl) |  | ||||||
|  |  | ||||||
| 			fmt.Printf("[CONF] Overwrite config '%s' with '%v'\n", fullEnvKey, envcvl.Interface()) |  | ||||||
|  |  | ||||||
| 		} else if rvfield.Type().ConvertibleTo(reflect.TypeOf("")) { |  | ||||||
|  |  | ||||||
| 			envcvl := reflect.ValueOf(envval).Convert(rvfield.Type()) |  | ||||||
|  |  | ||||||
| 			rvfield.Set(envcvl) |  | ||||||
|  |  | ||||||
| 			fmt.Printf("[CONF] Overwrite config '%s' with '%v'\n", fullEnvKey, envcvl.Interface()) |  | ||||||
|  |  | ||||||
| 		} else { | 		} else { | ||||||
| 			return errors.New(fmt.Sprintf("Unknown kind/type in config: [ %s | %s ]", rvfield.Kind().String(), rvfield.Type().String())) |  | ||||||
|  | 			newval, err := parseEnvToValue(envval, fullEnvKey, rvfield.Type()) | ||||||
|  | 			if err != nil { | ||||||
|  | 				return err | ||||||
|  | 			} | ||||||
|  |  | ||||||
|  | 			rvfield.Set(newval) | ||||||
|  | 			fmt.Printf("[CONF] Overwrite config '%s' with '%s'\n", fullEnvKey, envval) | ||||||
|  |  | ||||||
| 		} | 		} | ||||||
|  |  | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	return nil | 	return nil | ||||||
| } | } | ||||||
|  |  | ||||||
|  | func parseEnvToValue(envval string, fullEnvKey string, rvtype reflect.Type) (reflect.Value, error) { | ||||||
|  | 	if rvtype == reflect.TypeOf("") { | ||||||
|  |  | ||||||
|  | 		return reflect.ValueOf(envval), nil | ||||||
|  |  | ||||||
|  | 	} else if rvtype == reflect.TypeOf(int(0)) { | ||||||
|  |  | ||||||
|  | 		envint, err := strconv.ParseInt(envval, 10, bits.UintSize) | ||||||
|  | 		if err != nil { | ||||||
|  | 			return reflect.Value{}, errors.New(fmt.Sprintf("Failed to parse env-config variable '%s' to int (value := '%s')", fullEnvKey, envval)) | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		return reflect.ValueOf(int(envint)), nil | ||||||
|  |  | ||||||
|  | 	} else if rvtype == reflect.TypeOf(int64(0)) { | ||||||
|  |  | ||||||
|  | 		envint, err := strconv.ParseInt(envval, 10, 64) | ||||||
|  | 		if err != nil { | ||||||
|  | 			return reflect.Value{}, errors.New(fmt.Sprintf("Failed to parse env-config variable '%s' to int64 (value := '%s')", fullEnvKey, envval)) | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		return reflect.ValueOf(int64(envint)), nil | ||||||
|  |  | ||||||
|  | 	} else if rvtype == reflect.TypeOf(int32(0)) { | ||||||
|  |  | ||||||
|  | 		envint, err := strconv.ParseInt(envval, 10, 32) | ||||||
|  | 		if err != nil { | ||||||
|  | 			return reflect.Value{}, errors.New(fmt.Sprintf("Failed to parse env-config variable '%s' to int32 (value := '%s')", fullEnvKey, envval)) | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		return reflect.ValueOf(int32(envint)), nil | ||||||
|  |  | ||||||
|  | 	} else if rvtype == reflect.TypeOf(int8(0)) { | ||||||
|  |  | ||||||
|  | 		envint, err := strconv.ParseInt(envval, 10, 8) | ||||||
|  | 		if err != nil { | ||||||
|  | 			return reflect.Value{}, errors.New(fmt.Sprintf("Failed to parse env-config variable '%s' to int32 (value := '%s')", fullEnvKey, envval)) | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		return reflect.ValueOf(int8(envint)), nil | ||||||
|  |  | ||||||
|  | 	} else if rvtype == reflect.TypeOf(time.Duration(0)) { | ||||||
|  |  | ||||||
|  | 		dur, err := timeext.ParseDurationShortString(envval) | ||||||
|  | 		if err != nil { | ||||||
|  | 			return reflect.Value{}, errors.New(fmt.Sprintf("Failed to parse env-config variable '%s' to duration (value := '%s')", fullEnvKey, envval)) | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		return reflect.ValueOf(dur), nil | ||||||
|  |  | ||||||
|  | 	} else if rvtype == reflect.TypeOf(time.UnixMilli(0)) { | ||||||
|  |  | ||||||
|  | 		tim, err := time.Parse(time.RFC3339Nano, envval) | ||||||
|  | 		if err != nil { | ||||||
|  | 			return reflect.Value{}, errors.New(fmt.Sprintf("Failed to parse env-config variable '%s' to time.time (value := '%s')", fullEnvKey, envval)) | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		return reflect.ValueOf(tim), nil | ||||||
|  |  | ||||||
|  | 	} else if rvtype.ConvertibleTo(reflect.TypeOf(int(0))) { | ||||||
|  |  | ||||||
|  | 		envint, err := strconv.ParseInt(envval, 10, 8) | ||||||
|  | 		if err != nil { | ||||||
|  | 			return reflect.Value{}, errors.New(fmt.Sprintf("Failed to parse env-config variable '%s' to <%s, ,int> (value := '%s')", rvtype.Name(), fullEnvKey, envval)) | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		envcvl := reflect.ValueOf(envint).Convert(rvtype) | ||||||
|  |  | ||||||
|  | 		return envcvl, nil | ||||||
|  |  | ||||||
|  | 	} else if rvtype.ConvertibleTo(reflect.TypeOf(false)) { | ||||||
|  |  | ||||||
|  | 		if strings.TrimSpace(strings.ToLower(envval)) == "true" { | ||||||
|  | 			return reflect.ValueOf(true).Convert(rvtype), nil | ||||||
|  | 		} else if strings.TrimSpace(strings.ToLower(envval)) == "false" { | ||||||
|  | 			return reflect.ValueOf(false).Convert(rvtype), nil | ||||||
|  | 		} else if strings.TrimSpace(strings.ToLower(envval)) == "1" { | ||||||
|  | 			return reflect.ValueOf(true).Convert(rvtype), nil | ||||||
|  | 		} else if strings.TrimSpace(strings.ToLower(envval)) == "0" { | ||||||
|  | 			return reflect.ValueOf(false).Convert(rvtype), nil | ||||||
|  | 		} else { | ||||||
|  | 			return reflect.Value{}, errors.New(fmt.Sprintf("Failed to parse env-config variable '%s' to <%s, ,bool> (value := '%s')", rvtype.Name(), fullEnvKey, envval)) | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 	} else if rvtype.ConvertibleTo(reflect.TypeOf("")) { | ||||||
|  |  | ||||||
|  | 		envcvl := reflect.ValueOf(envval).Convert(rvtype) | ||||||
|  | 		return envcvl, nil | ||||||
|  |  | ||||||
|  | 	} else { | ||||||
|  | 		return reflect.Value{}, errors.New(fmt.Sprintf("Unknown kind/type in config: [ %s | %s ]", rvtype.Kind().String(), rvtype.String())) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|   | |||||||
| @@ -1,7 +1,8 @@ | |||||||
| package confext | package confext | ||||||
|  |  | ||||||
| import ( | import ( | ||||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/timeext" | 	"git.blackforestbytes.com/BlackForestBytes/goext/timeext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/tst" | ||||||
| 	"testing" | 	"testing" | ||||||
| 	"time" | 	"time" | ||||||
| ) | ) | ||||||
| @@ -41,13 +42,13 @@ func TestApplyEnvOverridesNoop(t *testing.T) { | |||||||
|  |  | ||||||
| 	output := input | 	output := input | ||||||
|  |  | ||||||
| 	err := ApplyEnvOverrides(&output, ".") | 	err := ApplyEnvOverrides("", &output, ".") | ||||||
| 	if err != nil { | 	if err != nil { | ||||||
| 		t.Errorf("%v", err) | 		t.Errorf("%v", err) | ||||||
| 		t.FailNow() | 		t.FailNow() | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	assertEqual(t, input, output) | 	tst.AssertEqual(t, input, output) | ||||||
| } | } | ||||||
|  |  | ||||||
| func TestApplyEnvOverridesSimple(t *testing.T) { | func TestApplyEnvOverridesSimple(t *testing.T) { | ||||||
| @@ -67,6 +68,7 @@ func TestApplyEnvOverridesSimple(t *testing.T) { | |||||||
| 		V7 aliasstring   `env:"TEST_V7"` | 		V7 aliasstring   `env:"TEST_V7"` | ||||||
| 		V8 time.Duration `env:"TEST_V8"` | 		V8 time.Duration `env:"TEST_V8"` | ||||||
| 		V9 time.Time     `env:"TEST_V9"` | 		V9 time.Time     `env:"TEST_V9"` | ||||||
|  | 		VA bool          `env:"TEST_VA"` | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	data := testdata{ | 	data := testdata{ | ||||||
| @@ -81,6 +83,7 @@ func TestApplyEnvOverridesSimple(t *testing.T) { | |||||||
| 		V7: "7", | 		V7: "7", | ||||||
| 		V8: 9, | 		V8: 9, | ||||||
| 		V9: time.Unix(1671102873, 0), | 		V9: time.Unix(1671102873, 0), | ||||||
|  | 		VA: false, | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	t.Setenv("TEST_V1", "846") | 	t.Setenv("TEST_V1", "846") | ||||||
| @@ -92,22 +95,24 @@ func TestApplyEnvOverridesSimple(t *testing.T) { | |||||||
| 	t.Setenv("TEST_V7", "AAAAAA") | 	t.Setenv("TEST_V7", "AAAAAA") | ||||||
| 	t.Setenv("TEST_V8", "1min4s") | 	t.Setenv("TEST_V8", "1min4s") | ||||||
| 	t.Setenv("TEST_V9", "2009-11-10T23:00:00Z") | 	t.Setenv("TEST_V9", "2009-11-10T23:00:00Z") | ||||||
|  | 	t.Setenv("TEST_VA", "true") | ||||||
|  |  | ||||||
| 	err := ApplyEnvOverrides(&data, ".") | 	err := ApplyEnvOverrides("", &data, ".") | ||||||
| 	if err != nil { | 	if err != nil { | ||||||
| 		t.Errorf("%v", err) | 		t.Errorf("%v", err) | ||||||
| 		t.FailNow() | 		t.FailNow() | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	assertEqual(t, data.V1, 846) | 	tst.AssertEqual(t, data.V1, 846) | ||||||
| 	assertEqual(t, data.V2, "hello_world") | 	tst.AssertEqual(t, data.V2, "hello_world") | ||||||
| 	assertEqual(t, data.V3, 6) | 	tst.AssertEqual(t, data.V3, 6) | ||||||
| 	assertEqual(t, data.V4, 333) | 	tst.AssertEqual(t, data.V4, 333) | ||||||
| 	assertEqual(t, data.V5, -937) | 	tst.AssertEqual(t, data.V5, -937) | ||||||
| 	assertEqual(t, data.V6, 70) | 	tst.AssertEqual(t, data.V6, 70) | ||||||
| 	assertEqual(t, data.V7, "AAAAAA") | 	tst.AssertEqual(t, data.V7, "AAAAAA") | ||||||
| 	assertEqual(t, data.V8, time.Second*64) | 	tst.AssertEqual(t, data.V8, time.Second*64) | ||||||
| 	assertEqual(t, data.V9, time.Unix(1257894000, 0).UTC()) | 	tst.AssertEqual(t, data.V9, time.Unix(1257894000, 0).UTC()) | ||||||
|  | 	tst.AssertEqual(t, data.VA, true) | ||||||
| } | } | ||||||
|  |  | ||||||
| func TestApplyEnvOverridesRecursive(t *testing.T) { | func TestApplyEnvOverridesRecursive(t *testing.T) { | ||||||
| @@ -182,35 +187,83 @@ func TestApplyEnvOverridesRecursive(t *testing.T) { | |||||||
| 	t.Setenv("SUB_V3", "33min") | 	t.Setenv("SUB_V3", "33min") | ||||||
| 	t.Setenv("SUB_V4", "2044-01-01T00:00:00Z") | 	t.Setenv("SUB_V4", "2044-01-01T00:00:00Z") | ||||||
|  |  | ||||||
| 	err := ApplyEnvOverrides(&data, "_") | 	err := ApplyEnvOverrides("", &data, "_") | ||||||
| 	if err != nil { | 	if err != nil { | ||||||
| 		t.Errorf("%v", err) | 		t.Errorf("%v", err) | ||||||
| 		t.FailNow() | 		t.FailNow() | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	assertEqual(t, data.V1, 999) | 	tst.AssertEqual(t, data.V1, 999) | ||||||
| 	assertEqual(t, data.VX, "2") | 	tst.AssertEqual(t, data.VX, "2") | ||||||
| 	assertEqual(t, data.V5, "no") | 	tst.AssertEqual(t, data.V5, "no") | ||||||
| 	assertEqual(t, data.Sub1.V1, 3) | 	tst.AssertEqual(t, data.Sub1.V1, 3) | ||||||
| 	assertEqual(t, data.Sub1.VX, "4") | 	tst.AssertEqual(t, data.Sub1.VX, "4") | ||||||
| 	assertEqual(t, data.Sub1.V2, "5") | 	tst.AssertEqual(t, data.Sub1.V2, "5") | ||||||
| 	assertEqual(t, data.Sub1.V8, time.Second*6) | 	tst.AssertEqual(t, data.Sub1.V8, time.Second*6) | ||||||
| 	assertEqual(t, data.Sub1.V9, time.Unix(947206861, 0).UTC()) | 	tst.AssertEqual(t, data.Sub1.V9, time.Unix(947206861, 0).UTC()) | ||||||
| 	assertEqual(t, data.Sub2.V1, 846) | 	tst.AssertEqual(t, data.Sub2.V1, 846) | ||||||
| 	assertEqual(t, data.Sub2.VX, "9") | 	tst.AssertEqual(t, data.Sub2.VX, "9") | ||||||
| 	assertEqual(t, data.Sub2.V2, "222_hello_world") | 	tst.AssertEqual(t, data.Sub2.V2, "222_hello_world") | ||||||
| 	assertEqual(t, data.Sub2.V8, time.Second*64) | 	tst.AssertEqual(t, data.Sub2.V8, time.Second*64) | ||||||
| 	assertEqual(t, data.Sub2.V9, time.Unix(1257894000, 0).UTC()) | 	tst.AssertEqual(t, data.Sub2.V9, time.Unix(1257894000, 0).UTC()) | ||||||
| 	assertEqual(t, data.Sub3.V1, 33846) | 	tst.AssertEqual(t, data.Sub3.V1, 33846) | ||||||
| 	assertEqual(t, data.Sub3.VX, "14") | 	tst.AssertEqual(t, data.Sub3.VX, "14") | ||||||
| 	assertEqual(t, data.Sub3.V2, "33_hello_world") | 	tst.AssertEqual(t, data.Sub3.V2, "33_hello_world") | ||||||
| 	assertEqual(t, data.Sub3.V8, time.Second*1984) | 	tst.AssertEqual(t, data.Sub3.V8, time.Second*1984) | ||||||
| 	assertEqual(t, data.Sub3.V9, time.Unix(2015276400, 0).UTC()) | 	tst.AssertEqual(t, data.Sub3.V9, time.Unix(2015276400, 0).UTC()) | ||||||
| 	assertEqual(t, data.Sub4.V1, 11) | 	tst.AssertEqual(t, data.Sub4.V1, 11) | ||||||
| 	assertEqual(t, data.Sub4.VX, "19") | 	tst.AssertEqual(t, data.Sub4.VX, "19") | ||||||
| 	assertEqual(t, data.Sub4.V2, "22") | 	tst.AssertEqual(t, data.Sub4.V2, "22") | ||||||
| 	assertEqual(t, data.Sub4.V8, time.Second*1980) | 	tst.AssertEqual(t, data.Sub4.V8, time.Second*1980) | ||||||
| 	assertEqual(t, data.Sub4.V9, time.Unix(2335219200, 0).UTC()) | 	tst.AssertEqual(t, data.Sub4.V9, time.Unix(2335219200, 0).UTC()) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestApplyEnvOverridesPointer(t *testing.T) { | ||||||
|  |  | ||||||
|  | 	type aliasint int | ||||||
|  | 	type aliasstring string | ||||||
|  |  | ||||||
|  | 	type testdata struct { | ||||||
|  | 		V1 *int           `env:"TEST_V1"` | ||||||
|  | 		VX *string        `` | ||||||
|  | 		V2 *string        `env:"TEST_V2"` | ||||||
|  | 		V3 *int8          `env:"TEST_V3"` | ||||||
|  | 		V4 *int32         `env:"TEST_V4"` | ||||||
|  | 		V5 *int64         `env:"TEST_V5"` | ||||||
|  | 		V6 *aliasint      `env:"TEST_V6"` | ||||||
|  | 		VY *aliasint      `` | ||||||
|  | 		V7 *aliasstring   `env:"TEST_V7"` | ||||||
|  | 		V8 *time.Duration `env:"TEST_V8"` | ||||||
|  | 		V9 *time.Time     `env:"TEST_V9"` | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	data := testdata{} | ||||||
|  |  | ||||||
|  | 	t.Setenv("TEST_V1", "846") | ||||||
|  | 	t.Setenv("TEST_V2", "hello_world") | ||||||
|  | 	t.Setenv("TEST_V3", "6") | ||||||
|  | 	t.Setenv("TEST_V4", "333") | ||||||
|  | 	t.Setenv("TEST_V5", "-937") | ||||||
|  | 	t.Setenv("TEST_V6", "070") | ||||||
|  | 	t.Setenv("TEST_V7", "AAAAAA") | ||||||
|  | 	t.Setenv("TEST_V8", "1min4s") | ||||||
|  | 	t.Setenv("TEST_V9", "2009-11-10T23:00:00Z") | ||||||
|  |  | ||||||
|  | 	err := ApplyEnvOverrides("", &data, ".") | ||||||
|  | 	if err != nil { | ||||||
|  | 		t.Errorf("%v", err) | ||||||
|  | 		t.FailNow() | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	tst.AssertDeRefEqual(t, data.V1, 846) | ||||||
|  | 	tst.AssertDeRefEqual(t, data.V2, "hello_world") | ||||||
|  | 	tst.AssertDeRefEqual(t, data.V3, 6) | ||||||
|  | 	tst.AssertDeRefEqual(t, data.V4, 333) | ||||||
|  | 	tst.AssertDeRefEqual(t, data.V5, -937) | ||||||
|  | 	tst.AssertDeRefEqual(t, data.V6, 70) | ||||||
|  | 	tst.AssertDeRefEqual(t, data.V7, "AAAAAA") | ||||||
|  | 	tst.AssertDeRefEqual(t, data.V8, time.Second*64) | ||||||
|  | 	tst.AssertDeRefEqual(t, data.V9, time.Unix(1257894000, 0).UTC()) | ||||||
| } | } | ||||||
|  |  | ||||||
| func assertEqual[T comparable](t *testing.T, actual T, expected T) { | func assertEqual[T comparable](t *testing.T, actual T, expected T) { | ||||||
| @@ -218,3 +271,12 @@ func assertEqual[T comparable](t *testing.T, actual T, expected T) { | |||||||
| 		t.Errorf("values differ: Actual: '%v', Expected: '%v'", actual, expected) | 		t.Errorf("values differ: Actual: '%v', Expected: '%v'", actual, expected) | ||||||
| 	} | 	} | ||||||
| } | } | ||||||
|  |  | ||||||
|  | func assertPtrEqual[T comparable](t *testing.T, actual *T, expected T) { | ||||||
|  | 	if actual == nil { | ||||||
|  | 		t.Errorf("values differ: Actual: NIL, Expected: '%v'", expected) | ||||||
|  | 	} | ||||||
|  | 	if *actual != expected { | ||||||
|  | 		t.Errorf("values differ: Actual: '%v', Expected: '%v'", actual, expected) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|   | |||||||
| @@ -2,6 +2,7 @@ package cryptext | |||||||
|  |  | ||||||
| import ( | import ( | ||||||
| 	"fmt" | 	"fmt" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/tst" | ||||||
| 	"testing" | 	"testing" | ||||||
| ) | ) | ||||||
|  |  | ||||||
| @@ -23,13 +24,13 @@ func TestEncryptAESSimple(t *testing.T) { | |||||||
| 		panic(err) | 		panic(err) | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	assertEqual(t, string(str1), string(str3)) | 	tst.AssertEqual(t, string(str1), string(str3)) | ||||||
|  |  | ||||||
| 	str4, err := EncryptAESSimple(pw, str3, 512) | 	str4, err := EncryptAESSimple(pw, str3, 512) | ||||||
| 	if err != nil { | 	if err != nil { | ||||||
| 		panic(err) | 		panic(err) | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	assertNotEqual(t, string(str2), string(str4)) | 	tst.AssertNotEqual(t, string(str2), string(str4)) | ||||||
|  |  | ||||||
| } | } | ||||||
|   | |||||||
| @@ -1,31 +1,20 @@ | |||||||
| package cryptext | package cryptext | ||||||
|  |  | ||||||
| import ( | import ( | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/tst" | ||||||
| 	"testing" | 	"testing" | ||||||
| ) | ) | ||||||
|  |  | ||||||
| func TestStrSha256(t *testing.T) { | func TestStrSha256(t *testing.T) { | ||||||
| 	assertEqual(t, StrSha256(""), "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855") | 	tst.AssertEqual(t, StrSha256(""), "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855") | ||||||
| 	assertEqual(t, StrSha256("0"), "5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9") | 	tst.AssertEqual(t, StrSha256("0"), "5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9") | ||||||
| 	assertEqual(t, StrSha256("80085"), "b3786e141d65638ad8a98173e26b5f6a53c927737b23ff31fb1843937250f44b") | 	tst.AssertEqual(t, StrSha256("80085"), "b3786e141d65638ad8a98173e26b5f6a53c927737b23ff31fb1843937250f44b") | ||||||
| 	assertEqual(t, StrSha256("Hello World"), "a591a6d40bf420404a011733cfb7b190d62c65bf0bcda32b57b277d9ad9f146e") | 	tst.AssertEqual(t, StrSha256("Hello World"), "a591a6d40bf420404a011733cfb7b190d62c65bf0bcda32b57b277d9ad9f146e") | ||||||
| } | } | ||||||
|  |  | ||||||
| func TestBytesSha256(t *testing.T) { | func TestBytesSha256(t *testing.T) { | ||||||
| 	assertEqual(t, BytesSha256([]byte{}), "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855") | 	tst.AssertEqual(t, BytesSha256([]byte{}), "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855") | ||||||
| 	assertEqual(t, BytesSha256([]byte{0}), "6e340b9cffb37a989ca544e6bb780a2c78901d3fb33738768511a30617afa01d") | 	tst.AssertEqual(t, BytesSha256([]byte{0}), "6e340b9cffb37a989ca544e6bb780a2c78901d3fb33738768511a30617afa01d") | ||||||
| 	assertEqual(t, BytesSha256([]byte{128}), "76be8b528d0075f7aae98d6fa57a6d3c83ae480a8469e668d7b0af968995ac71") | 	tst.AssertEqual(t, BytesSha256([]byte{128}), "76be8b528d0075f7aae98d6fa57a6d3c83ae480a8469e668d7b0af968995ac71") | ||||||
| 	assertEqual(t, BytesSha256([]byte{0, 1, 2, 4, 8, 16, 32, 64, 128, 255}), "55016a318ba538e00123c736b2a8b6db368d00e7e25727547655b653e5853603") | 	tst.AssertEqual(t, BytesSha256([]byte{0, 1, 2, 4, 8, 16, 32, 64, 128, 255}), "55016a318ba538e00123c736b2a8b6db368d00e7e25727547655b653e5853603") | ||||||
| } |  | ||||||
|  |  | ||||||
| func assertEqual(t *testing.T, actual string, expected string) { |  | ||||||
| 	if actual != expected { |  | ||||||
| 		t.Errorf("values differ: Actual: '%v', Expected: '%v'", actual, expected) |  | ||||||
| 	} |  | ||||||
| } |  | ||||||
|  |  | ||||||
| func assertNotEqual(t *testing.T, actual string, expected string) { |  | ||||||
| 	if actual == expected { |  | ||||||
| 		t.Errorf("values do not differ: Actual: '%v', Expected: '%v'", actual, expected) |  | ||||||
| 	} |  | ||||||
| } | } | ||||||
|   | |||||||
| @@ -3,25 +3,29 @@ package cryptext | |||||||
| import ( | import ( | ||||||
| 	"crypto/rand" | 	"crypto/rand" | ||||||
| 	"crypto/sha256" | 	"crypto/sha256" | ||||||
|  | 	"crypto/sha512" | ||||||
| 	"encoding/base64" | 	"encoding/base64" | ||||||
| 	"encoding/hex" | 	"encoding/hex" | ||||||
|  | 	"encoding/json" | ||||||
| 	"errors" | 	"errors" | ||||||
| 	"fmt" | 	"fmt" | ||||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/langext" |  | ||||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/totpext" |  | ||||||
| 	"golang.org/x/crypto/bcrypt" |  | ||||||
| 	"strconv" | 	"strconv" | ||||||
| 	"strings" | 	"strings" | ||||||
|  |  | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/totpext" | ||||||
|  | 	"golang.org/x/crypto/bcrypt" | ||||||
| ) | ) | ||||||
|  |  | ||||||
| const LatestPassHashVersion = 4 | const LatestPassHashVersion = 5 | ||||||
|  |  | ||||||
| // PassHash | // PassHash | ||||||
| // - [v0]: plaintext password ( `0|...` ) | // - [v0]: plaintext password ( `0|...` )                  // simple, used to write PW's directly in DB | ||||||
| // - [v1]: sha256(plaintext) | // - [v1]: sha256(plaintext)                               // simple hashing | ||||||
| // - [v2]: seed | sha256<seed>(plaintext) | // - [v2]: seed | sha256<seed>(plaintext)                  // add seed | ||||||
| // - [v3]: seed | sha256<seed>(plaintext) | [hex(totp)] | // - [v3]: seed | sha256<seed>(plaintext) | [hex(totp)]    // add TOTP support | ||||||
| // - [v4]: bcrypt(plaintext) | [hex(totp)] | // - [v4]: bcrypt(plaintext) | [hex(totp)]                 // use proper bcrypt | ||||||
|  | // - [v5]: bcrypt(sha512(plaintext)) | [hex(totp)]         // hash pw before bcrypt (otherwise max pw-len = 72) | ||||||
| type PassHash string | type PassHash string | ||||||
|  |  | ||||||
| func (ph PassHash) Valid() bool { | func (ph PassHash) Valid() bool { | ||||||
| @@ -64,7 +68,6 @@ func (ph PassHash) Data() (_version int, _seed []byte, _payload []byte, _totp bo | |||||||
| 		return int(version), nil, payload, false, nil, true | 		return int(version), nil, payload, false, nil, true | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	// |  | ||||||
| 	if version == 2 { | 	if version == 2 { | ||||||
| 		if len(split) != 3 { | 		if len(split) != 3 { | ||||||
| 			return -1, nil, nil, false, nil, false | 			return -1, nil, nil, false, nil, false | ||||||
| @@ -109,7 +112,21 @@ func (ph PassHash) Data() (_version int, _seed []byte, _payload []byte, _totp bo | |||||||
| 		totp := false | 		totp := false | ||||||
| 		totpsecret := make([]byte, 0) | 		totpsecret := make([]byte, 0) | ||||||
| 		if split[2] != "0" { | 		if split[2] != "0" { | ||||||
| 			totpsecret, err = hex.DecodeString(split[3]) | 			totpsecret, err = hex.DecodeString(split[2]) | ||||||
|  | 			totp = true | ||||||
|  | 		} | ||||||
|  | 		return int(version), nil, payload, totp, totpsecret, true | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if version == 5 { | ||||||
|  | 		if len(split) != 3 { | ||||||
|  | 			return -1, nil, nil, false, nil, false | ||||||
|  | 		} | ||||||
|  | 		payload := []byte(split[1]) | ||||||
|  | 		totp := false | ||||||
|  | 		totpsecret := make([]byte, 0) | ||||||
|  | 		if split[2] != "0" { | ||||||
|  | 			totpsecret, err = hex.DecodeString(split[2]) | ||||||
| 			totp = true | 			totp = true | ||||||
| 		} | 		} | ||||||
| 		return int(version), nil, payload, totp, totpsecret, true | 		return int(version), nil, payload, totp, totpsecret, true | ||||||
| @@ -156,6 +173,14 @@ func (ph PassHash) Verify(plainpass string, totp *string) bool { | |||||||
| 		} | 		} | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
|  | 	if version == 5 { | ||||||
|  | 		if !hastotp { | ||||||
|  | 			return bcrypt.CompareHashAndPassword(payload, hash512(plainpass)) == nil | ||||||
|  | 		} else { | ||||||
|  | 			return bcrypt.CompareHashAndPassword(payload, hash512(plainpass)) == nil && totpext.Validate(totpsecret, *totp) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
| 	return false | 	return false | ||||||
| } | } | ||||||
|  |  | ||||||
| @@ -209,6 +234,12 @@ func (ph PassHash) ClearTOTP() (PassHash, error) { | |||||||
| 		return PassHash(strings.Join(split, "|")), nil | 		return PassHash(strings.Join(split, "|")), nil | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
|  | 	if version == 5 { | ||||||
|  | 		split := strings.Split(string(ph), "|") | ||||||
|  | 		split[2] = "0" | ||||||
|  | 		return PassHash(strings.Join(split, "|")), nil | ||||||
|  | 	} | ||||||
|  |  | ||||||
| 	return "", errors.New("unknown version") | 	return "", errors.New("unknown version") | ||||||
| } | } | ||||||
|  |  | ||||||
| @@ -242,6 +273,12 @@ func (ph PassHash) WithTOTP(totpSecret []byte) (PassHash, error) { | |||||||
| 		return PassHash(strings.Join(split, "|")), nil | 		return PassHash(strings.Join(split, "|")), nil | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
|  | 	if version == 5 { | ||||||
|  | 		split := strings.Split(string(ph), "|") | ||||||
|  | 		split[2] = hex.EncodeToString(totpSecret) | ||||||
|  | 		return PassHash(strings.Join(split, "|")), nil | ||||||
|  | 	} | ||||||
|  |  | ||||||
| 	return "", errors.New("unknown version") | 	return "", errors.New("unknown version") | ||||||
| } | } | ||||||
|  |  | ||||||
| @@ -271,6 +308,10 @@ func (ph PassHash) Change(newPlainPass string) (PassHash, error) { | |||||||
| 		return HashPasswordV4(newPlainPass, langext.Conditional(hastotp, totpsecret, nil)) | 		return HashPasswordV4(newPlainPass, langext.Conditional(hastotp, totpsecret, nil)) | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
|  | 	if version == 5 { | ||||||
|  | 		return HashPasswordV5(newPlainPass, langext.Conditional(hastotp, totpsecret, nil)) | ||||||
|  | 	} | ||||||
|  |  | ||||||
| 	return "", errors.New("unknown version") | 	return "", errors.New("unknown version") | ||||||
| } | } | ||||||
|  |  | ||||||
| @@ -278,8 +319,32 @@ func (ph PassHash) String() string { | |||||||
| 	return string(ph) | 	return string(ph) | ||||||
| } | } | ||||||
|  |  | ||||||
|  | func (ph PassHash) MarshalJSON() ([]byte, error) { | ||||||
|  | 	if ph == "" { | ||||||
|  | 		return json.Marshal("") | ||||||
|  | 	} | ||||||
|  | 	return json.Marshal("*****") | ||||||
|  | } | ||||||
|  |  | ||||||
| func HashPassword(plainpass string, totpSecret []byte) (PassHash, error) { | func HashPassword(plainpass string, totpSecret []byte) (PassHash, error) { | ||||||
| 	return HashPasswordV4(plainpass, totpSecret) | 	return HashPasswordV5(plainpass, totpSecret) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func HashPasswordV5(plainpass string, totpSecret []byte) (PassHash, error) { | ||||||
|  | 	var strtotp string | ||||||
|  |  | ||||||
|  | 	if totpSecret == nil { | ||||||
|  | 		strtotp = "0" | ||||||
|  | 	} else { | ||||||
|  | 		strtotp = hex.EncodeToString(totpSecret) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	payload, err := bcrypt.GenerateFromPassword(hash512(plainpass), bcrypt.MinCost) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return "", err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return PassHash(fmt.Sprintf("5|%s|%s", string(payload), strtotp)), nil | ||||||
| } | } | ||||||
|  |  | ||||||
| func HashPasswordV4(plainpass string, totpSecret []byte) (PassHash, error) { | func HashPasswordV4(plainpass string, totpSecret []byte) (PassHash, error) { | ||||||
| @@ -340,6 +405,13 @@ func HashPasswordV0(plainpass string) (PassHash, error) { | |||||||
| 	return PassHash(fmt.Sprintf("0|%s", plainpass)), nil | 	return PassHash(fmt.Sprintf("0|%s", plainpass)), nil | ||||||
| } | } | ||||||
|  |  | ||||||
|  | func hash512(s string) []byte { | ||||||
|  | 	h := sha512.New() | ||||||
|  | 	h.Write([]byte(s)) | ||||||
|  | 	bs := h.Sum(nil) | ||||||
|  | 	return bs | ||||||
|  | } | ||||||
|  |  | ||||||
| func hash256(s string) []byte { | func hash256(s string) []byte { | ||||||
| 	h := sha256.New() | 	h := sha256.New() | ||||||
| 	h.Write([]byte(s)) | 	h.Write([]byte(s)) | ||||||
|   | |||||||
							
								
								
									
										210
									
								
								cryptext/passHash_test.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										210
									
								
								cryptext/passHash_test.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,210 @@ | |||||||
|  | package cryptext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/totpext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/tst" | ||||||
|  | 	"testing" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | func TestPassHash1(t *testing.T) { | ||||||
|  | 	ph, err := HashPassword("test123", nil) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Valid()) | ||||||
|  | 	tst.AssertFalse(t, ph.HasTOTP()) | ||||||
|  | 	tst.AssertFalse(t, ph.NeedsPasswordUpgrade()) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Verify("test123", nil)) | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test124", nil)) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestPassHashTOTP(t *testing.T) { | ||||||
|  | 	sec, err := totpext.GenerateSecret() | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	ph, err := HashPassword("test123", sec) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Valid()) | ||||||
|  | 	tst.AssertTrue(t, ph.HasTOTP()) | ||||||
|  | 	tst.AssertFalse(t, ph.NeedsPasswordUpgrade()) | ||||||
|  |  | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test123", nil)) | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test124", nil)) | ||||||
|  | 	tst.AssertTrue(t, ph.Verify("test123", langext.Ptr(totpext.TOTP(sec)))) | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test124", nil)) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestPassHashUpgrade_V0(t *testing.T) { | ||||||
|  | 	ph, err := HashPasswordV0("test123") | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Valid()) | ||||||
|  | 	tst.AssertFalse(t, ph.HasTOTP()) | ||||||
|  | 	tst.AssertTrue(t, ph.NeedsPasswordUpgrade()) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Verify("test123", nil)) | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test124", nil)) | ||||||
|  |  | ||||||
|  | 	ph, err = ph.Upgrade("test123") | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Valid()) | ||||||
|  | 	tst.AssertFalse(t, ph.HasTOTP()) | ||||||
|  | 	tst.AssertFalse(t, ph.NeedsPasswordUpgrade()) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Verify("test123", nil)) | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test124", nil)) | ||||||
|  |  | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestPassHashUpgrade_V1(t *testing.T) { | ||||||
|  | 	ph, err := HashPasswordV1("test123") | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Valid()) | ||||||
|  | 	tst.AssertFalse(t, ph.HasTOTP()) | ||||||
|  | 	tst.AssertTrue(t, ph.NeedsPasswordUpgrade()) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Verify("test123", nil)) | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test124", nil)) | ||||||
|  |  | ||||||
|  | 	ph, err = ph.Upgrade("test123") | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Valid()) | ||||||
|  | 	tst.AssertFalse(t, ph.HasTOTP()) | ||||||
|  | 	tst.AssertFalse(t, ph.NeedsPasswordUpgrade()) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Verify("test123", nil)) | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test124", nil)) | ||||||
|  |  | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestPassHashUpgrade_V2(t *testing.T) { | ||||||
|  | 	ph, err := HashPasswordV2("test123") | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Valid()) | ||||||
|  | 	tst.AssertFalse(t, ph.HasTOTP()) | ||||||
|  | 	tst.AssertTrue(t, ph.NeedsPasswordUpgrade()) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Verify("test123", nil)) | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test124", nil)) | ||||||
|  |  | ||||||
|  | 	ph, err = ph.Upgrade("test123") | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Valid()) | ||||||
|  | 	tst.AssertFalse(t, ph.HasTOTP()) | ||||||
|  | 	tst.AssertFalse(t, ph.NeedsPasswordUpgrade()) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Verify("test123", nil)) | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test124", nil)) | ||||||
|  |  | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestPassHashUpgrade_V3(t *testing.T) { | ||||||
|  | 	ph, err := HashPasswordV3("test123", nil) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Valid()) | ||||||
|  | 	tst.AssertFalse(t, ph.HasTOTP()) | ||||||
|  | 	tst.AssertTrue(t, ph.NeedsPasswordUpgrade()) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Verify("test123", nil)) | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test124", nil)) | ||||||
|  |  | ||||||
|  | 	ph, err = ph.Upgrade("test123") | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Valid()) | ||||||
|  | 	tst.AssertFalse(t, ph.HasTOTP()) | ||||||
|  | 	tst.AssertFalse(t, ph.NeedsPasswordUpgrade()) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Verify("test123", nil)) | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test124", nil)) | ||||||
|  |  | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestPassHashUpgrade_V3_TOTP(t *testing.T) { | ||||||
|  | 	sec, err := totpext.GenerateSecret() | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	ph, err := HashPasswordV3("test123", sec) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Valid()) | ||||||
|  | 	tst.AssertTrue(t, ph.HasTOTP()) | ||||||
|  | 	tst.AssertTrue(t, ph.NeedsPasswordUpgrade()) | ||||||
|  |  | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test123", nil)) | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test124", nil)) | ||||||
|  | 	tst.AssertTrue(t, ph.Verify("test123", langext.Ptr(totpext.TOTP(sec)))) | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test124", nil)) | ||||||
|  |  | ||||||
|  | 	ph, err = ph.Upgrade("test123") | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Valid()) | ||||||
|  | 	tst.AssertTrue(t, ph.HasTOTP()) | ||||||
|  | 	tst.AssertFalse(t, ph.NeedsPasswordUpgrade()) | ||||||
|  |  | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test123", nil)) | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test124", nil)) | ||||||
|  | 	tst.AssertTrue(t, ph.Verify("test123", langext.Ptr(totpext.TOTP(sec)))) | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test124", nil)) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestPassHashUpgrade_V4(t *testing.T) { | ||||||
|  | 	ph, err := HashPasswordV4("test123", nil) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Valid()) | ||||||
|  | 	tst.AssertFalse(t, ph.HasTOTP()) | ||||||
|  | 	tst.AssertTrue(t, ph.NeedsPasswordUpgrade()) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Verify("test123", nil)) | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test124", nil)) | ||||||
|  |  | ||||||
|  | 	ph, err = ph.Upgrade("test123") | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Valid()) | ||||||
|  | 	tst.AssertFalse(t, ph.HasTOTP()) | ||||||
|  | 	tst.AssertFalse(t, ph.NeedsPasswordUpgrade()) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Verify("test123", nil)) | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test124", nil)) | ||||||
|  |  | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestPassHashUpgrade_V4_TOTP(t *testing.T) { | ||||||
|  | 	sec, err := totpext.GenerateSecret() | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	ph, err := HashPasswordV4("test123", sec) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Valid()) | ||||||
|  | 	tst.AssertTrue(t, ph.HasTOTP()) | ||||||
|  | 	tst.AssertTrue(t, ph.NeedsPasswordUpgrade()) | ||||||
|  |  | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test123", nil)) | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test124", nil)) | ||||||
|  | 	tst.AssertTrue(t, ph.Verify("test123", langext.Ptr(totpext.TOTP(sec)))) | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test124", nil)) | ||||||
|  |  | ||||||
|  | 	ph, err = ph.Upgrade("test123") | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, ph.Valid()) | ||||||
|  | 	tst.AssertTrue(t, ph.HasTOTP()) | ||||||
|  | 	tst.AssertFalse(t, ph.NeedsPasswordUpgrade()) | ||||||
|  |  | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test123", nil)) | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test124", nil)) | ||||||
|  | 	tst.AssertTrue(t, ph.Verify("test123", langext.Ptr(totpext.TOTP(sec)))) | ||||||
|  | 	tst.AssertFalse(t, ph.Verify("test124", nil)) | ||||||
|  | } | ||||||
							
								
								
									
										263
									
								
								cryptext/pronouncablePassword.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										263
									
								
								cryptext/pronouncablePassword.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,263 @@ | |||||||
|  | package cryptext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"crypto/rand" | ||||||
|  | 	"io" | ||||||
|  | 	"math/big" | ||||||
|  | 	mathrand "math/rand" | ||||||
|  | 	"strings" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | const ( | ||||||
|  | 	ppStartChar            = "BCDFGHJKLMNPQRSTVWXZ" | ||||||
|  | 	ppEndChar              = "ABDEFIKMNORSTUXYZ" | ||||||
|  | 	ppVowel                = "AEIOUY" | ||||||
|  | 	ppConsonant            = "BCDFGHJKLMNPQRSTVWXZ" | ||||||
|  | 	ppSegmentLenMin        = 3 | ||||||
|  | 	ppSegmentLenMax        = 7 | ||||||
|  | 	ppMaxRepeatedVowel     = 2 | ||||||
|  | 	ppMaxRepeatedConsonant = 2 | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | var ppContinuation = map[uint8]string{ | ||||||
|  | 	'A': "BCDFGHJKLMNPRSTVWXYZ", | ||||||
|  | 	'B': "ADFIKLMNORSTUY", | ||||||
|  | 	'C': "AEIKOUY", | ||||||
|  | 	'D': "AEILORSUYZ", | ||||||
|  | 	'E': "BCDFGHJKLMNPRSTVWXYZ", | ||||||
|  | 	'F': "ADEGIKLOPRTUY", | ||||||
|  | 	'G': "ABDEFHILMNORSTUY", | ||||||
|  | 	'H': "AEIOUY", | ||||||
|  | 	'I': "BCDFGHJKLMNPRSTVWXZ", | ||||||
|  | 	'J': "AEIOUY", | ||||||
|  | 	'K': "ADEFHILMNORSTUY", | ||||||
|  | 	'L': "ADEFGIJKMNOPSTUVWYZ", | ||||||
|  | 	'M': "ABEFIKOPSTUY", | ||||||
|  | 	'N': "ABEFIKOPSTUY", | ||||||
|  | 	'O': "BCDFGHJKLMNPRSTVWXYZ", | ||||||
|  | 	'P': "AEFIJLORSTUY", | ||||||
|  | 	'Q': "AEIOUY", | ||||||
|  | 	'R': "ADEFGHIJKLMNOPSTUVYZ", | ||||||
|  | 	'S': "ACDEIKLOPTUYZ", | ||||||
|  | 	'T': "AEHIJOPRSUWY", | ||||||
|  | 	'U': "BCDFGHJKLMNPRSTVWXZ", | ||||||
|  | 	'V': "AEIOUY", | ||||||
|  | 	'W': "AEIOUY", | ||||||
|  | 	'X': "AEIOUY", | ||||||
|  | 	'Y': "ABCDFGHKLMNPRSTVXZ", | ||||||
|  | 	'Z': "AEILOTUY", | ||||||
|  | } | ||||||
|  |  | ||||||
|  | var ppLog2Map = map[int]float64{ | ||||||
|  | 	1:  0.00000000, | ||||||
|  | 	2:  1.00000000, | ||||||
|  | 	3:  1.58496250, | ||||||
|  | 	4:  2.00000000, | ||||||
|  | 	5:  2.32192809, | ||||||
|  | 	6:  2.58496250, | ||||||
|  | 	7:  2.80735492, | ||||||
|  | 	8:  3.00000000, | ||||||
|  | 	9:  3.16992500, | ||||||
|  | 	10: 3.32192809, | ||||||
|  | 	11: 3.45943162, | ||||||
|  | 	12: 3.58496250, | ||||||
|  | 	13: 3.70043972, | ||||||
|  | 	14: 3.80735492, | ||||||
|  | 	15: 3.90689060, | ||||||
|  | 	16: 4.00000000, | ||||||
|  | 	17: 4.08746284, | ||||||
|  | 	18: 4.16992500, | ||||||
|  | 	19: 4.24792751, | ||||||
|  | 	20: 4.32192809, | ||||||
|  | 	21: 4.39231742, | ||||||
|  | 	22: 4.45943162, | ||||||
|  | 	23: 4.52356196, | ||||||
|  | 	24: 4.58496250, | ||||||
|  | 	25: 4.64385619, | ||||||
|  | 	26: 4.70043972, | ||||||
|  | 	27: 4.75488750, | ||||||
|  | 	28: 4.80735492, | ||||||
|  | 	29: 4.85798100, | ||||||
|  | 	30: 4.90689060, | ||||||
|  | 	31: 4.95419631, | ||||||
|  | 	32: 5.00000000, | ||||||
|  | } | ||||||
|  |  | ||||||
|  | var ( | ||||||
|  | 	ppVowelMap     = ppMakeSet(ppVowel) | ||||||
|  | 	ppConsonantMap = ppMakeSet(ppConsonant) | ||||||
|  | 	ppEndCharMap   = ppMakeSet(ppEndChar) | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | func ppMakeSet(v string) map[uint8]bool { | ||||||
|  | 	mp := make(map[uint8]bool, len(v)) | ||||||
|  | 	for _, chr := range v { | ||||||
|  | 		mp[uint8(chr)] = true | ||||||
|  | 	} | ||||||
|  | 	return mp | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func ppRandInt(rng io.Reader, max int) int { | ||||||
|  | 	v, err := rand.Int(rng, big.NewInt(int64(max))) | ||||||
|  | 	if err != nil { | ||||||
|  | 		panic(err) | ||||||
|  | 	} | ||||||
|  | 	return int(v.Int64()) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func ppRand(rng io.Reader, chars string, entropy *float64) uint8 { | ||||||
|  | 	chr := chars[ppRandInt(rng, len(chars))] | ||||||
|  |  | ||||||
|  | 	*entropy = *entropy + ppLog2Map[len(chars)] | ||||||
|  |  | ||||||
|  | 	return chr | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func ppCharType(chr uint8) (bool, bool) { | ||||||
|  | 	_, ok1 := ppVowelMap[chr] | ||||||
|  | 	_, ok2 := ppConsonantMap[chr] | ||||||
|  |  | ||||||
|  | 	return ok1, ok2 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func ppCharsetRemove(cs string, set map[uint8]bool, allowEmpty bool) string { | ||||||
|  | 	result := "" | ||||||
|  | 	for _, chr := range cs { | ||||||
|  | 		if _, ok := set[uint8(chr)]; !ok { | ||||||
|  | 			result += string(chr) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | 	if result == "" && !allowEmpty { | ||||||
|  | 		return cs | ||||||
|  | 	} | ||||||
|  | 	return result | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func ppCharsetFilter(cs string, set map[uint8]bool, allowEmpty bool) string { | ||||||
|  | 	result := "" | ||||||
|  | 	for _, chr := range cs { | ||||||
|  | 		if _, ok := set[uint8(chr)]; ok { | ||||||
|  | 			result += string(chr) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | 	if result == "" && !allowEmpty { | ||||||
|  | 		return cs | ||||||
|  | 	} | ||||||
|  | 	return result | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func PronouncablePasswordExt(rng io.Reader, pwlen int) (string, float64) { | ||||||
|  |  | ||||||
|  | 	// kinda pseudo markov-chain - with a few extra rules and no weights... | ||||||
|  |  | ||||||
|  | 	if pwlen <= 0 { | ||||||
|  | 		return "", 0 | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	vowelCount := 0 | ||||||
|  | 	consoCount := 0 | ||||||
|  | 	entropy := float64(0) | ||||||
|  |  | ||||||
|  | 	startChar := ppRand(rng, ppStartChar, &entropy) | ||||||
|  |  | ||||||
|  | 	result := string(startChar) | ||||||
|  | 	currentChar := startChar | ||||||
|  |  | ||||||
|  | 	isVowel, isConsonant := ppCharType(currentChar) | ||||||
|  | 	if isVowel { | ||||||
|  | 		vowelCount = 1 | ||||||
|  | 	} | ||||||
|  | 	if isConsonant { | ||||||
|  | 		consoCount = ppMaxRepeatedConsonant | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	segmentLen := 1 | ||||||
|  |  | ||||||
|  | 	segmentLenTarget := ppSegmentLenMin + ppRandInt(rng, ppSegmentLenMax-ppSegmentLenMin) | ||||||
|  |  | ||||||
|  | 	for len(result) < pwlen { | ||||||
|  |  | ||||||
|  | 		charset := ppContinuation[currentChar] | ||||||
|  | 		if vowelCount >= ppMaxRepeatedVowel { | ||||||
|  | 			charset = ppCharsetRemove(charset, ppVowelMap, false) | ||||||
|  | 		} | ||||||
|  | 		if consoCount >= ppMaxRepeatedConsonant { | ||||||
|  | 			charset = ppCharsetRemove(charset, ppConsonantMap, false) | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		lastOfSegment := false | ||||||
|  | 		newSegment := false | ||||||
|  |  | ||||||
|  | 		if len(result)+1 == pwlen { | ||||||
|  | 			// last of result | ||||||
|  | 			charset = ppCharsetFilter(charset, ppEndCharMap, false) | ||||||
|  | 		} else if segmentLen+1 == segmentLenTarget { | ||||||
|  | 			// last of segment | ||||||
|  | 			charsetNew := ppCharsetFilter(charset, ppEndCharMap, true) | ||||||
|  | 			if charsetNew != "" { | ||||||
|  | 				charset = charsetNew | ||||||
|  | 				lastOfSegment = true | ||||||
|  | 			} | ||||||
|  | 		} else if segmentLen >= segmentLenTarget { | ||||||
|  | 			// (perhaps) start of new segment | ||||||
|  | 			if _, ok := ppEndCharMap[currentChar]; ok { | ||||||
|  | 				charset = ppStartChar | ||||||
|  | 				newSegment = true | ||||||
|  | 			} else { | ||||||
|  | 				// continue segment for one more char to (hopefully) find an end-char | ||||||
|  | 				charsetNew := ppCharsetFilter(charset, ppEndCharMap, true) | ||||||
|  | 				if charsetNew != "" { | ||||||
|  | 					charset = charsetNew | ||||||
|  | 					lastOfSegment = true | ||||||
|  | 				} | ||||||
|  | 			} | ||||||
|  | 		} else { | ||||||
|  | 			// normal continuation | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		newChar := ppRand(rng, charset, &entropy) | ||||||
|  | 		if lastOfSegment { | ||||||
|  | 			currentChar = newChar | ||||||
|  | 			segmentLen++ | ||||||
|  | 			result += strings.ToLower(string(newChar)) | ||||||
|  | 		} else if newSegment { | ||||||
|  | 			currentChar = newChar | ||||||
|  | 			segmentLen = 1 | ||||||
|  | 			result += strings.ToUpper(string(newChar)) | ||||||
|  | 			segmentLenTarget = ppSegmentLenMin + ppRandInt(rng, ppSegmentLenMax-ppSegmentLenMin) | ||||||
|  | 			vowelCount = 0 | ||||||
|  | 			consoCount = 0 | ||||||
|  | 		} else { | ||||||
|  | 			currentChar = newChar | ||||||
|  | 			segmentLen++ | ||||||
|  | 			result += strings.ToLower(string(newChar)) | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		isVowel, isConsonant := ppCharType(currentChar) | ||||||
|  | 		if isVowel { | ||||||
|  | 			vowelCount++ | ||||||
|  | 			consoCount = 0 | ||||||
|  | 		} | ||||||
|  | 		if isConsonant { | ||||||
|  | 			vowelCount = 0 | ||||||
|  | 			if newSegment { | ||||||
|  | 				consoCount = ppMaxRepeatedConsonant | ||||||
|  | 			} else { | ||||||
|  | 				consoCount++ | ||||||
|  | 			} | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return result, entropy | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func PronouncablePassword(len int) string { | ||||||
|  | 	v, _ := PronouncablePasswordExt(rand.Reader, len) | ||||||
|  | 	return v | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func PronouncablePasswordSeeded(seed int64, len int) string { | ||||||
|  |  | ||||||
|  | 	v, _ := PronouncablePasswordExt(mathrand.New(mathrand.NewSource(seed)), len) | ||||||
|  | 	return v | ||||||
|  | } | ||||||
							
								
								
									
										35
									
								
								cryptext/pronouncablePassword_test.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										35
									
								
								cryptext/pronouncablePassword_test.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,35 @@ | |||||||
|  | package cryptext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"fmt" | ||||||
|  | 	"math/rand" | ||||||
|  | 	"testing" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | func TestPronouncablePasswordExt(t *testing.T) { | ||||||
|  | 	for i := 0; i < 20; i++ { | ||||||
|  | 		pw, entropy := PronouncablePasswordExt(rand.New(rand.NewSource(int64(i))), 16) | ||||||
|  | 		fmt.Printf("[%.2f] => %s\n", entropy, pw) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestPronouncablePasswordSeeded(t *testing.T) { | ||||||
|  | 	for i := 0; i < 20; i++ { | ||||||
|  | 		pw := PronouncablePasswordSeeded(int64(i), 8) | ||||||
|  | 		fmt.Printf("%s\n", pw) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestPronouncablePassword(t *testing.T) { | ||||||
|  | 	for i := 0; i < 20; i++ { | ||||||
|  | 		pw := PronouncablePassword(i + 1) | ||||||
|  | 		fmt.Printf("%s\n", pw) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestPronouncablePasswordWrongLen(t *testing.T) { | ||||||
|  | 	PronouncablePassword(0) | ||||||
|  | 	PronouncablePassword(-1) | ||||||
|  | 	PronouncablePassword(-2) | ||||||
|  | 	PronouncablePassword(-3) | ||||||
|  | } | ||||||
							
								
								
									
										27
									
								
								ctxext/getter.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										27
									
								
								ctxext/getter.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,27 @@ | |||||||
|  | package ctxext | ||||||
|  |  | ||||||
|  | import "context" | ||||||
|  |  | ||||||
|  | func Value[T any](ctx context.Context, key any) (T, bool) { | ||||||
|  | 	v := ctx.Value(key) | ||||||
|  | 	if v == nil { | ||||||
|  | 		return *new(T), false | ||||||
|  | 	} | ||||||
|  | 	if tv, ok := v.(T); !ok { | ||||||
|  | 		return *new(T), false | ||||||
|  | 	} else { | ||||||
|  | 		return tv, true | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func ValueOrDefault[T any](ctx context.Context, key any, def T) T { | ||||||
|  | 	v := ctx.Value(key) | ||||||
|  | 	if v == nil { | ||||||
|  | 		return def | ||||||
|  | 	} | ||||||
|  | 	if tv, ok := v.(T); !ok { | ||||||
|  | 		return def | ||||||
|  | 	} else { | ||||||
|  | 		return tv | ||||||
|  | 	} | ||||||
|  | } | ||||||
							
								
								
									
										18
									
								
								cursortoken/direction.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										18
									
								
								cursortoken/direction.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,18 @@ | |||||||
|  | package cursortoken | ||||||
|  |  | ||||||
|  | type SortDirection string //@enum:type | ||||||
|  |  | ||||||
|  | const ( | ||||||
|  | 	SortASC  SortDirection = "ASC" | ||||||
|  | 	SortDESC SortDirection = "DESC" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | func (sd SortDirection) ToMongo() int { | ||||||
|  | 	if sd == SortASC { | ||||||
|  | 		return 1 | ||||||
|  | 	} else if sd == SortDESC { | ||||||
|  | 		return -1 | ||||||
|  | 	} else { | ||||||
|  | 		return 0 | ||||||
|  | 	} | ||||||
|  | } | ||||||
							
								
								
									
										15
									
								
								cursortoken/filter.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								cursortoken/filter.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,15 @@ | |||||||
|  | package cursortoken | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"context" | ||||||
|  | 	"go.mongodb.org/mongo-driver/mongo" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | type RawFilter interface { | ||||||
|  | 	FilterQuery(ctx context.Context) mongo.Pipeline | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type Filter interface { | ||||||
|  | 	FilterQuery(ctx context.Context) mongo.Pipeline | ||||||
|  | 	Pagination(ctx context.Context) (string, SortDirection, string, SortDirection) | ||||||
|  | } | ||||||
							
								
								
									
										95
									
								
								cursortoken/token.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										95
									
								
								cursortoken/token.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,95 @@ | |||||||
|  | package cursortoken | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"encoding/base32" | ||||||
|  | 	"encoding/json" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/exerr" | ||||||
|  | 	"strconv" | ||||||
|  | 	"strings" | ||||||
|  | 	"time" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | type CursorToken interface { | ||||||
|  | 	Token() string | ||||||
|  | 	IsStart() bool | ||||||
|  | 	IsEnd() bool | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type Mode string | ||||||
|  |  | ||||||
|  | const ( | ||||||
|  | 	CTMStart  Mode = "START" | ||||||
|  | 	CTMNormal Mode = "NORMAL" | ||||||
|  | 	CTMEnd    Mode = "END" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | type Extra struct { | ||||||
|  | 	Timestamp *time.Time | ||||||
|  | 	Id        *string | ||||||
|  | 	Page      *int | ||||||
|  | 	PageSize  *int | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func Decode(tok string) (CursorToken, error) { | ||||||
|  | 	if tok == "" { | ||||||
|  | 		return Start(), nil | ||||||
|  | 	} | ||||||
|  | 	if strings.ToLower(tok) == "@start" { | ||||||
|  | 		return Start(), nil | ||||||
|  | 	} | ||||||
|  | 	if strings.ToLower(tok) == "@end" { | ||||||
|  | 		return End(), nil | ||||||
|  | 	} | ||||||
|  | 	if strings.ToLower(tok) == "$end" { | ||||||
|  | 		return PageEnd(), nil | ||||||
|  | 	} | ||||||
|  | 	if strings.HasPrefix(tok, "$") && len(tok) > 1 { | ||||||
|  | 		n, err := strconv.ParseInt(tok[1:], 10, 64) | ||||||
|  | 		if err != nil { | ||||||
|  | 			return nil, exerr.Wrap(err, "failed to deserialize token").Str("token", tok).WithType(exerr.TypeCursorTokenDecode).Build() | ||||||
|  | 		} | ||||||
|  | 		return Page(int(n)), nil | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if strings.HasPrefix(tok, "tok_") { | ||||||
|  |  | ||||||
|  | 		body, err := base32.StdEncoding.DecodeString(tok[len("tok_"):]) | ||||||
|  | 		if err != nil { | ||||||
|  | 			return nil, err | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		var tokenDeserialize cursorTokenKeySortSerialize | ||||||
|  | 		err = json.Unmarshal(body, &tokenDeserialize) | ||||||
|  | 		if err != nil { | ||||||
|  | 			return nil, exerr.Wrap(err, "failed to deserialize token").Str("token", tok).WithType(exerr.TypeCursorTokenDecode).Build() | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		token := CTKeySort{Mode: CTMNormal} | ||||||
|  |  | ||||||
|  | 		if tokenDeserialize.ValuePrimary != nil { | ||||||
|  | 			token.ValuePrimary = *tokenDeserialize.ValuePrimary | ||||||
|  | 		} | ||||||
|  | 		if tokenDeserialize.ValueSecondary != nil { | ||||||
|  | 			token.ValueSecondary = *tokenDeserialize.ValueSecondary | ||||||
|  | 		} | ||||||
|  | 		if tokenDeserialize.Direction != nil { | ||||||
|  | 			token.Direction = *tokenDeserialize.Direction | ||||||
|  | 		} | ||||||
|  | 		if tokenDeserialize.DirectionSecondary != nil { | ||||||
|  | 			token.DirectionSecondary = *tokenDeserialize.DirectionSecondary | ||||||
|  | 		} | ||||||
|  | 		if tokenDeserialize.PageSize != nil { | ||||||
|  | 			token.PageSize = *tokenDeserialize.PageSize | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		token.Extra.Timestamp = tokenDeserialize.ExtraTimestamp | ||||||
|  | 		token.Extra.Id = tokenDeserialize.ExtraId | ||||||
|  | 		token.Extra.Page = tokenDeserialize.ExtraPage | ||||||
|  | 		token.Extra.PageSize = tokenDeserialize.ExtraPageSize | ||||||
|  |  | ||||||
|  | 		return token, nil | ||||||
|  |  | ||||||
|  | 	} else { | ||||||
|  | 		return nil, exerr.New(exerr.TypeCursorTokenDecode, "could not decode token, missing/unknown prefix").Str("token", tok).Build() | ||||||
|  | 	} | ||||||
|  | } | ||||||
							
								
								
									
										136
									
								
								cursortoken/tokenKeySort.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										136
									
								
								cursortoken/tokenKeySort.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,136 @@ | |||||||
|  | package cursortoken | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"encoding/base32" | ||||||
|  | 	"encoding/json" | ||||||
|  | 	"go.mongodb.org/mongo-driver/bson/primitive" | ||||||
|  | 	"time" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | type CTKeySort struct { | ||||||
|  | 	Mode               Mode | ||||||
|  | 	ValuePrimary       string | ||||||
|  | 	ValueSecondary     string | ||||||
|  | 	Direction          SortDirection | ||||||
|  | 	DirectionSecondary SortDirection | ||||||
|  | 	PageSize           int | ||||||
|  | 	Extra              Extra | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type cursorTokenKeySortSerialize struct { | ||||||
|  | 	ValuePrimary       *string        `json:"v1,omitempty"` | ||||||
|  | 	ValueSecondary     *string        `json:"v2,omitempty"` | ||||||
|  | 	Direction          *SortDirection `json:"dir,omitempty"` | ||||||
|  | 	DirectionSecondary *SortDirection `json:"dir2,omitempty"` | ||||||
|  | 	PageSize           *int           `json:"size,omitempty"` | ||||||
|  |  | ||||||
|  | 	ExtraTimestamp *time.Time `json:"ts,omitempty"` | ||||||
|  | 	ExtraId        *string    `json:"id,omitempty"` | ||||||
|  | 	ExtraPage      *int       `json:"pg,omitempty"` | ||||||
|  | 	ExtraPageSize  *int       `json:"sz,omitempty"` | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewKeySortToken(valuePrimary string, valueSecondary string, direction SortDirection, directionSecondary SortDirection, pageSize int, extra Extra) CursorToken { | ||||||
|  | 	return CTKeySort{ | ||||||
|  | 		Mode:               CTMNormal, | ||||||
|  | 		ValuePrimary:       valuePrimary, | ||||||
|  | 		ValueSecondary:     valueSecondary, | ||||||
|  | 		Direction:          direction, | ||||||
|  | 		DirectionSecondary: directionSecondary, | ||||||
|  | 		PageSize:           pageSize, | ||||||
|  | 		Extra:              extra, | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func Start() CursorToken { | ||||||
|  | 	return CTKeySort{ | ||||||
|  | 		Mode:               CTMStart, | ||||||
|  | 		ValuePrimary:       "", | ||||||
|  | 		ValueSecondary:     "", | ||||||
|  | 		Direction:          "", | ||||||
|  | 		DirectionSecondary: "", | ||||||
|  | 		PageSize:           0, | ||||||
|  | 		Extra:              Extra{}, | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func End() CursorToken { | ||||||
|  | 	return CTKeySort{ | ||||||
|  | 		Mode:               CTMEnd, | ||||||
|  | 		ValuePrimary:       "", | ||||||
|  | 		ValueSecondary:     "", | ||||||
|  | 		Direction:          "", | ||||||
|  | 		DirectionSecondary: "", | ||||||
|  | 		PageSize:           0, | ||||||
|  | 		Extra:              Extra{}, | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (c CTKeySort) Token() string { | ||||||
|  |  | ||||||
|  | 	if c.Mode == CTMStart { | ||||||
|  | 		return "@start" | ||||||
|  | 	} | ||||||
|  | 	if c.Mode == CTMEnd { | ||||||
|  | 		return "@end" | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// We kinda manually implement omitempty for the CursorToken here | ||||||
|  | 	// because omitempty does not work for time.Time and otherwise we would always | ||||||
|  | 	// get weird time values when decoding a token that initially didn't have an Timestamp set | ||||||
|  | 	// For this usecase we treat Unix=0 as an empty timestamp | ||||||
|  |  | ||||||
|  | 	sertok := cursorTokenKeySortSerialize{} | ||||||
|  |  | ||||||
|  | 	if c.ValuePrimary != "" { | ||||||
|  | 		sertok.ValuePrimary = &c.ValuePrimary | ||||||
|  | 	} | ||||||
|  | 	if c.ValueSecondary != "" { | ||||||
|  | 		sertok.ValueSecondary = &c.ValueSecondary | ||||||
|  | 	} | ||||||
|  | 	if c.Direction != "" { | ||||||
|  | 		sertok.Direction = &c.Direction | ||||||
|  | 	} | ||||||
|  | 	if c.DirectionSecondary != "" { | ||||||
|  | 		sertok.DirectionSecondary = &c.DirectionSecondary | ||||||
|  | 	} | ||||||
|  | 	if c.PageSize != 0 { | ||||||
|  | 		sertok.PageSize = &c.PageSize | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	sertok.ExtraTimestamp = c.Extra.Timestamp | ||||||
|  | 	sertok.ExtraId = c.Extra.Id | ||||||
|  | 	sertok.ExtraPage = c.Extra.Page | ||||||
|  | 	sertok.ExtraPageSize = c.Extra.PageSize | ||||||
|  |  | ||||||
|  | 	body, err := json.Marshal(sertok) | ||||||
|  | 	if err != nil { | ||||||
|  | 		panic(err) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return "tok_" + base32.StdEncoding.EncodeToString(body) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (c CTKeySort) IsEnd() bool { | ||||||
|  | 	return c.Mode == CTMEnd | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (c CTKeySort) IsStart() bool { | ||||||
|  | 	return c.Mode == CTMStart | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (c CTKeySort) valuePrimaryObjectId() (primitive.ObjectID, bool) { | ||||||
|  | 	if oid, err := primitive.ObjectIDFromHex(c.ValuePrimary); err == nil { | ||||||
|  | 		return oid, true | ||||||
|  | 	} else { | ||||||
|  | 		return primitive.ObjectID{}, false | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (c CTKeySort) valueSecondaryObjectId() (primitive.ObjectID, bool) { | ||||||
|  | 	if oid, err := primitive.ObjectIDFromHex(c.ValueSecondary); err == nil { | ||||||
|  | 		return oid, true | ||||||
|  | 	} else { | ||||||
|  | 		return primitive.ObjectID{}, false | ||||||
|  | 	} | ||||||
|  | } | ||||||
							
								
								
									
										41
									
								
								cursortoken/tokenPaginate.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										41
									
								
								cursortoken/tokenPaginate.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,41 @@ | |||||||
|  | package cursortoken | ||||||
|  |  | ||||||
|  | import "strconv" | ||||||
|  |  | ||||||
|  | type CTPaginated struct { | ||||||
|  | 	Mode Mode | ||||||
|  | 	Page int | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func Page(p int) CursorToken { | ||||||
|  | 	return CTPaginated{ | ||||||
|  | 		Mode: CTMNormal, | ||||||
|  | 		Page: p, | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func PageEnd() CursorToken { | ||||||
|  | 	return CTPaginated{ | ||||||
|  | 		Mode: CTMEnd, | ||||||
|  | 		Page: 0, | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (c CTPaginated) Token() string { | ||||||
|  | 	if c.Mode == CTMStart { | ||||||
|  | 		return "$1" | ||||||
|  | 	} | ||||||
|  | 	if c.Mode == CTMEnd { | ||||||
|  | 		return "$end" | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return "$" + strconv.Itoa(c.Page) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (c CTPaginated) IsEnd() bool { | ||||||
|  | 	return c.Mode == CTMEnd | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (c CTPaginated) IsStart() bool { | ||||||
|  | 	return c.Mode == CTMStart || c.Page == 1 | ||||||
|  | } | ||||||
							
								
								
									
										230
									
								
								dataext/broadcaster.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										230
									
								
								dataext/broadcaster.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,230 @@ | |||||||
|  | package dataext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"context" | ||||||
|  | 	"iter" | ||||||
|  | 	"sync" | ||||||
|  | 	"time" | ||||||
|  |  | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/syncext" | ||||||
|  | 	"github.com/rs/xid" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | // Broadcaster is a simple Broadcaster channel | ||||||
|  | // This is a simpler interface over Broadcaster - which does not have distinct namespaces | ||||||
|  | type Broadcaster[TData any] struct { | ||||||
|  | 	masterLock *sync.Mutex | ||||||
|  |  | ||||||
|  | 	subscriptions []*broadcastSubscription[TData] | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type BroadcastSubscription interface { | ||||||
|  | 	Unsubscribe() | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type broadcastSubscription[TData any] struct { | ||||||
|  | 	ID string | ||||||
|  |  | ||||||
|  | 	parent *Broadcaster[TData] | ||||||
|  |  | ||||||
|  | 	subLock *sync.Mutex | ||||||
|  |  | ||||||
|  | 	Func func(TData) | ||||||
|  | 	Chan chan TData | ||||||
|  |  | ||||||
|  | 	UnsubChan chan bool | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (p *broadcastSubscription[TData]) Unsubscribe() { | ||||||
|  | 	p.parent.unsubscribe(p) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewBroadcaster[TData any](capacity int) *Broadcaster[TData] { | ||||||
|  | 	return &Broadcaster[TData]{ | ||||||
|  | 		masterLock:    &sync.Mutex{}, | ||||||
|  | 		subscriptions: make([]*broadcastSubscription[TData], 0, capacity), | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (bb *Broadcaster[TData]) SubscriberCount() int { | ||||||
|  | 	bb.masterLock.Lock() | ||||||
|  | 	defer bb.masterLock.Unlock() | ||||||
|  |  | ||||||
|  | 	return len(bb.subscriptions) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // Publish sends `data` to all subscriber | ||||||
|  | // But unbuffered - if one is currently not listening, we skip (the actualReceiver < subscriber) | ||||||
|  | func (bb *Broadcaster[TData]) Publish(data TData) (subscriber int, actualReceiver int) { | ||||||
|  | 	bb.masterLock.Lock() | ||||||
|  | 	subs := langext.ArrCopy(bb.subscriptions) | ||||||
|  | 	bb.masterLock.Unlock() | ||||||
|  |  | ||||||
|  | 	subscriber = len(subs) | ||||||
|  | 	actualReceiver = 0 | ||||||
|  |  | ||||||
|  | 	for _, sub := range subs { | ||||||
|  | 		func() { | ||||||
|  | 			sub.subLock.Lock() | ||||||
|  | 			defer sub.subLock.Unlock() | ||||||
|  |  | ||||||
|  | 			if sub.Func != nil { | ||||||
|  | 				go func() { sub.Func(data) }() | ||||||
|  | 				actualReceiver++ | ||||||
|  | 			} else if sub.Chan != nil { | ||||||
|  | 				msgSent := syncext.WriteNonBlocking(sub.Chan, data) | ||||||
|  | 				if msgSent { | ||||||
|  | 					actualReceiver++ | ||||||
|  | 				} | ||||||
|  | 			} | ||||||
|  | 		}() | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return subscriber, actualReceiver | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // PublishWithContext sends `data` to all subscriber | ||||||
|  | // buffered - if one is currently not listening, we wait (but error out when the context runs out) | ||||||
|  | func (bb *Broadcaster[TData]) PublishWithContext(ctx context.Context, data TData) (subscriber int, actualReceiver int, err error) { | ||||||
|  | 	bb.masterLock.Lock() | ||||||
|  | 	subs := langext.ArrCopy(bb.subscriptions) | ||||||
|  | 	bb.masterLock.Unlock() | ||||||
|  |  | ||||||
|  | 	subscriber = len(subs) | ||||||
|  | 	actualReceiver = 0 | ||||||
|  |  | ||||||
|  | 	for _, sub := range subs { | ||||||
|  | 		err := func() error { | ||||||
|  | 			sub.subLock.Lock() | ||||||
|  | 			defer sub.subLock.Unlock() | ||||||
|  |  | ||||||
|  | 			if err := ctx.Err(); err != nil { | ||||||
|  | 				return err | ||||||
|  | 			} | ||||||
|  |  | ||||||
|  | 			if sub.Func != nil { | ||||||
|  | 				go func() { sub.Func(data) }() | ||||||
|  | 				actualReceiver++ | ||||||
|  | 			} else if sub.Chan != nil { | ||||||
|  | 				err := syncext.WriteChannelWithContext(ctx, sub.Chan, data) | ||||||
|  | 				if err != nil { | ||||||
|  | 					return err | ||||||
|  | 				} | ||||||
|  | 				actualReceiver++ | ||||||
|  | 			} | ||||||
|  |  | ||||||
|  | 			return nil | ||||||
|  | 		}() | ||||||
|  | 		if err != nil { | ||||||
|  | 			return subscriber, actualReceiver, err | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return subscriber, actualReceiver, nil | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // PublishWithTimeout sends `data` to all subscriber | ||||||
|  | // buffered - if one is currently not listening, we wait (but wait at most `timeout` - if the timeout is exceeded then actualReceiver < subscriber) | ||||||
|  | func (bb *Broadcaster[TData]) PublishWithTimeout(data TData, timeout time.Duration) (subscriber int, actualReceiver int) { | ||||||
|  | 	bb.masterLock.Lock() | ||||||
|  | 	subs := langext.ArrCopy(bb.subscriptions) | ||||||
|  | 	bb.masterLock.Unlock() | ||||||
|  |  | ||||||
|  | 	subscriber = len(subs) | ||||||
|  | 	actualReceiver = 0 | ||||||
|  |  | ||||||
|  | 	for _, sub := range subs { | ||||||
|  | 		func() { | ||||||
|  | 			sub.subLock.Lock() | ||||||
|  | 			defer sub.subLock.Unlock() | ||||||
|  |  | ||||||
|  | 			if sub.Func != nil { | ||||||
|  | 				go func() { sub.Func(data) }() | ||||||
|  | 				actualReceiver++ | ||||||
|  | 			} else if sub.Chan != nil { | ||||||
|  | 				ok := syncext.WriteChannelWithTimeout(sub.Chan, data, timeout) | ||||||
|  | 				if ok { | ||||||
|  | 					actualReceiver++ | ||||||
|  | 				} | ||||||
|  | 			} | ||||||
|  | 		}() | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return subscriber, actualReceiver | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (bb *Broadcaster[TData]) SubscribeByCallback(fn func(TData)) BroadcastSubscription { | ||||||
|  | 	bb.masterLock.Lock() | ||||||
|  | 	defer bb.masterLock.Unlock() | ||||||
|  |  | ||||||
|  | 	sub := &broadcastSubscription[TData]{ID: xid.New().String(), parent: bb, subLock: &sync.Mutex{}, Func: fn, UnsubChan: nil} | ||||||
|  |  | ||||||
|  | 	bb.subscriptions = append(bb.subscriptions, sub) | ||||||
|  |  | ||||||
|  | 	return sub | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (bb *Broadcaster[TData]) SubscribeByChan(chanBufferSize int) (chan TData, BroadcastSubscription) { | ||||||
|  | 	bb.masterLock.Lock() | ||||||
|  | 	defer bb.masterLock.Unlock() | ||||||
|  |  | ||||||
|  | 	msgCh := make(chan TData, chanBufferSize) | ||||||
|  |  | ||||||
|  | 	sub := &broadcastSubscription[TData]{ID: xid.New().String(), parent: bb, subLock: &sync.Mutex{}, Chan: msgCh, UnsubChan: nil} | ||||||
|  |  | ||||||
|  | 	bb.subscriptions = append(bb.subscriptions, sub) | ||||||
|  |  | ||||||
|  | 	return msgCh, sub | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (bb *Broadcaster[TData]) SubscribeByIter(chanBufferSize int) (iter.Seq[TData], BroadcastSubscription) { | ||||||
|  | 	bb.masterLock.Lock() | ||||||
|  | 	defer bb.masterLock.Unlock() | ||||||
|  |  | ||||||
|  | 	msgCh := make(chan TData, chanBufferSize) | ||||||
|  | 	unsubChan := make(chan bool, 8) | ||||||
|  |  | ||||||
|  | 	sub := &broadcastSubscription[TData]{ID: xid.New().String(), parent: bb, subLock: &sync.Mutex{}, Chan: msgCh, UnsubChan: unsubChan} | ||||||
|  |  | ||||||
|  | 	bb.subscriptions = append(bb.subscriptions, sub) | ||||||
|  |  | ||||||
|  | 	iterFun := func(yield func(TData) bool) { | ||||||
|  | 		for { | ||||||
|  | 			select { | ||||||
|  | 			case msg := <-msgCh: | ||||||
|  | 				if !yield(msg) { | ||||||
|  | 					sub.Unsubscribe() | ||||||
|  | 					return | ||||||
|  | 				} | ||||||
|  | 			case <-sub.UnsubChan: | ||||||
|  | 				sub.Unsubscribe() | ||||||
|  | 				return | ||||||
|  | 			} | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return iterFun, sub | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (bb *Broadcaster[TData]) unsubscribe(p *broadcastSubscription[TData]) { | ||||||
|  | 	bb.masterLock.Lock() | ||||||
|  | 	defer bb.masterLock.Unlock() | ||||||
|  |  | ||||||
|  | 	p.subLock.Lock() | ||||||
|  | 	defer p.subLock.Unlock() | ||||||
|  |  | ||||||
|  | 	if p.Chan != nil { | ||||||
|  | 		close(p.Chan) | ||||||
|  | 		p.Chan = nil | ||||||
|  | 	} | ||||||
|  | 	if p.UnsubChan != nil { | ||||||
|  | 		syncext.WriteNonBlocking(p.UnsubChan, true) | ||||||
|  | 		close(p.UnsubChan) | ||||||
|  | 		p.UnsubChan = nil | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	bb.subscriptions = langext.ArrFilter(bb.subscriptions, func(v *broadcastSubscription[TData]) bool { | ||||||
|  | 		return v.ID != p.ID | ||||||
|  | 	}) | ||||||
|  | } | ||||||
							
								
								
									
										332
									
								
								dataext/broadcaster_test.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										332
									
								
								dataext/broadcaster_test.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,332 @@ | |||||||
|  | package dataext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"context" | ||||||
|  | 	"sync" | ||||||
|  | 	"testing" | ||||||
|  | 	"time" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | func TestNewBroadcast(t *testing.T) { | ||||||
|  | 	bb := NewBroadcaster[string](10) | ||||||
|  | 	if bb == nil { | ||||||
|  | 		t.Fatal("NewBroadcaster returned nil") | ||||||
|  | 	} | ||||||
|  | 	if bb.masterLock == nil { | ||||||
|  | 		t.Fatal("masterLock is nil") | ||||||
|  | 	} | ||||||
|  | 	if bb.subscriptions == nil { | ||||||
|  | 		t.Fatal("subscriptions is nil") | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestBroadcast_SubscribeByCallback(t *testing.T) { | ||||||
|  | 	bb := NewBroadcaster[string](10) | ||||||
|  |  | ||||||
|  | 	var received string | ||||||
|  | 	var wg sync.WaitGroup | ||||||
|  | 	wg.Add(1) | ||||||
|  |  | ||||||
|  | 	callback := func(msg string) { | ||||||
|  | 		received = msg | ||||||
|  | 		wg.Done() | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	sub := bb.SubscribeByCallback(callback) | ||||||
|  | 	defer sub.Unsubscribe() | ||||||
|  |  | ||||||
|  | 	// Publish a message | ||||||
|  | 	subs, receivers := bb.Publish("hello") | ||||||
|  |  | ||||||
|  | 	if subs != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 subscriber, got %d", subs) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if receivers != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 receiver, got %d", receivers) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Wait for the callback to be executed | ||||||
|  | 	wg.Wait() | ||||||
|  |  | ||||||
|  | 	if received != "hello" { | ||||||
|  | 		t.Fatalf("Expected to receive 'hello', got '%s'", received) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestBroadcast_SubscribeByChan(t *testing.T) { | ||||||
|  | 	bb := NewBroadcaster[string](10) | ||||||
|  |  | ||||||
|  | 	ch, sub := bb.SubscribeByChan(1) | ||||||
|  | 	defer sub.Unsubscribe() | ||||||
|  |  | ||||||
|  | 	// Publish a message | ||||||
|  | 	subs, receivers := bb.Publish("hello") | ||||||
|  |  | ||||||
|  | 	if subs != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 subscriber, got %d", subs) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if receivers != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 receiver, got %d", receivers) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Read from the channel with a timeout to avoid blocking | ||||||
|  | 	select { | ||||||
|  | 	case msg := <-ch: | ||||||
|  | 		if msg != "hello" { | ||||||
|  | 			t.Fatalf("Expected to receive 'hello', got '%s'", msg) | ||||||
|  | 		} | ||||||
|  | 	case <-time.After(time.Second): | ||||||
|  | 		t.Fatal("Timed out waiting for message") | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestBroadcast_SubscribeByIter(t *testing.T) { | ||||||
|  | 	bb := NewBroadcaster[string](10) | ||||||
|  |  | ||||||
|  | 	iterSeq, sub := bb.SubscribeByIter(1) | ||||||
|  | 	defer sub.Unsubscribe() | ||||||
|  |  | ||||||
|  | 	// Channel to communicate when message is received | ||||||
|  | 	done := make(chan bool) | ||||||
|  | 	received := false | ||||||
|  |  | ||||||
|  | 	// Start a goroutine to use the iterator | ||||||
|  | 	go func() { | ||||||
|  | 		for msg := range iterSeq { | ||||||
|  | 			if msg == "hello" { | ||||||
|  | 				received = true | ||||||
|  | 				done <- true | ||||||
|  | 				return // Stop iteration | ||||||
|  | 			} | ||||||
|  | 		} | ||||||
|  | 	}() | ||||||
|  |  | ||||||
|  | 	// Give time for the iterator to start | ||||||
|  | 	time.Sleep(100 * time.Millisecond) | ||||||
|  |  | ||||||
|  | 	// Publish a message | ||||||
|  | 	bb.Publish("hello") | ||||||
|  |  | ||||||
|  | 	// Wait for the message to be received or timeout | ||||||
|  | 	select { | ||||||
|  | 	case <-done: | ||||||
|  | 		if !received { | ||||||
|  | 			t.Fatal("Message was received but not 'hello'") | ||||||
|  | 		} | ||||||
|  | 	case <-time.After(time.Second): | ||||||
|  | 		t.Fatal("Timed out waiting for message") | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	subCount := bb.SubscriberCount() | ||||||
|  | 	if subCount != 0 { | ||||||
|  | 		t.Fatalf("Expected 0 receivers, got %d", subCount) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestBroadcast_Publish(t *testing.T) { | ||||||
|  | 	bb := NewBroadcaster[string](10) | ||||||
|  |  | ||||||
|  | 	// Test publishing with no subscribers | ||||||
|  | 	subs, receivers := bb.Publish("hello") | ||||||
|  | 	if subs != 0 { | ||||||
|  | 		t.Fatalf("Expected 0 subscribers, got %d", subs) | ||||||
|  | 	} | ||||||
|  | 	if receivers != 0 { | ||||||
|  | 		t.Fatalf("Expected 0 receivers, got %d", receivers) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Add a subscriber | ||||||
|  | 	ch, sub := bb.SubscribeByChan(1) | ||||||
|  | 	defer sub.Unsubscribe() | ||||||
|  |  | ||||||
|  | 	// Publish a message | ||||||
|  | 	subs, receivers = bb.Publish("hello") | ||||||
|  | 	if subs != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 subscriber, got %d", subs) | ||||||
|  | 	} | ||||||
|  | 	if receivers != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 receiver, got %d", receivers) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Verify the message was received | ||||||
|  | 	select { | ||||||
|  | 	case msg := <-ch: | ||||||
|  | 		if msg != "hello" { | ||||||
|  | 			t.Fatalf("Expected to receive 'hello', got '%s'", msg) | ||||||
|  | 		} | ||||||
|  | 	case <-time.After(time.Second): | ||||||
|  | 		t.Fatal("Timed out waiting for message") | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Test non-blocking behavior with a full channel | ||||||
|  | 	// First fill the channel | ||||||
|  | 	bb.Publish("fill") | ||||||
|  |  | ||||||
|  | 	// Now publish again - this should not block but may skip the receiver | ||||||
|  | 	subs, receivers = bb.Publish("overflow") | ||||||
|  | 	if subs != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 subscriber, got %d", subs) | ||||||
|  | 	} | ||||||
|  | 	_ = receivers // may be 0 if channel is full | ||||||
|  |  | ||||||
|  | 	// Drain the channel | ||||||
|  | 	<-ch | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestBroadcast_PublishWithTimeout(t *testing.T) { | ||||||
|  | 	bb := NewBroadcaster[string](10) | ||||||
|  |  | ||||||
|  | 	// Add a subscriber with a channel | ||||||
|  | 	ch, sub := bb.SubscribeByChan(1) | ||||||
|  | 	defer sub.Unsubscribe() | ||||||
|  |  | ||||||
|  | 	// Publish with a timeout | ||||||
|  | 	subs, receivers := bb.PublishWithTimeout("hello", 100*time.Millisecond) | ||||||
|  | 	if subs != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 subscriber, got %d", subs) | ||||||
|  | 	} | ||||||
|  | 	if receivers != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 receiver, got %d", receivers) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Verify the message was received | ||||||
|  | 	select { | ||||||
|  | 	case msg := <-ch: | ||||||
|  | 		if msg != "hello" { | ||||||
|  | 			t.Fatalf("Expected to receive 'hello', got '%s'", msg) | ||||||
|  | 		} | ||||||
|  | 	case <-time.After(time.Second): | ||||||
|  | 		t.Fatal("Timed out waiting for message") | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Fill the channel | ||||||
|  | 	bb.Publish("fill") | ||||||
|  |  | ||||||
|  | 	// Test timeout behavior with a full channel | ||||||
|  | 	start := time.Now() | ||||||
|  | 	subs, receivers = bb.PublishWithTimeout("timeout-test", 50*time.Millisecond) | ||||||
|  | 	elapsed := time.Since(start) | ||||||
|  |  | ||||||
|  | 	if subs != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 subscriber, got %d", subs) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// The receiver count should be 0 if the timeout occurred | ||||||
|  | 	if elapsed < 50*time.Millisecond { | ||||||
|  | 		t.Fatalf("Expected to wait at least 50ms, only waited %v", elapsed) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Drain the channel | ||||||
|  | 	<-ch | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestBroadcast_PublishWithContext(t *testing.T) { | ||||||
|  | 	bb := NewBroadcaster[string](10) | ||||||
|  |  | ||||||
|  | 	// Add a subscriber with a channel | ||||||
|  | 	ch, sub := bb.SubscribeByChan(1) | ||||||
|  | 	defer sub.Unsubscribe() | ||||||
|  |  | ||||||
|  | 	// Create a context | ||||||
|  | 	ctx, cancel := context.WithTimeout(context.Background(), 100*time.Millisecond) | ||||||
|  | 	defer cancel() | ||||||
|  |  | ||||||
|  | 	// Publish with context | ||||||
|  | 	subs, receivers, err := bb.PublishWithContext(ctx, "hello") | ||||||
|  | 	if err != nil { | ||||||
|  | 		t.Fatalf("Unexpected error: %v", err) | ||||||
|  | 	} | ||||||
|  | 	if subs != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 subscriber, got %d", subs) | ||||||
|  | 	} | ||||||
|  | 	if receivers != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 receiver, got %d", receivers) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Verify the message was received | ||||||
|  | 	select { | ||||||
|  | 	case msg := <-ch: | ||||||
|  | 		if msg != "hello" { | ||||||
|  | 			t.Fatalf("Expected to receive 'hello', got '%s'", msg) | ||||||
|  | 		} | ||||||
|  | 	case <-time.After(time.Second): | ||||||
|  | 		t.Fatal("Timed out waiting for message") | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Fill the channel | ||||||
|  | 	bb.Publish("fill") | ||||||
|  |  | ||||||
|  | 	// Test context cancellation with a full channel | ||||||
|  | 	ctx, cancel = context.WithCancel(context.Background()) | ||||||
|  |  | ||||||
|  | 	// Cancel the context after a short delay | ||||||
|  | 	go func() { | ||||||
|  | 		time.Sleep(50 * time.Millisecond) | ||||||
|  | 		cancel() | ||||||
|  | 	}() | ||||||
|  |  | ||||||
|  | 	start := time.Now() | ||||||
|  | 	subs, receivers, err = bb.PublishWithContext(ctx, "context-test") | ||||||
|  | 	elapsed := time.Since(start) | ||||||
|  |  | ||||||
|  | 	if subs != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 subscriber, got %d", subs) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Should get a context canceled error | ||||||
|  | 	if err == nil { | ||||||
|  | 		t.Fatal("Expected context canceled error, got nil") | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if elapsed < 50*time.Millisecond { | ||||||
|  | 		t.Fatalf("Expected to wait at least 50ms, only waited %v", elapsed) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Drain the channel | ||||||
|  | 	<-ch | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestBroadcast_Unsubscribe(t *testing.T) { | ||||||
|  | 	bb := NewBroadcaster[string](10) | ||||||
|  |  | ||||||
|  | 	// Add a subscriber | ||||||
|  | 	ch, sub := bb.SubscribeByChan(1) | ||||||
|  |  | ||||||
|  | 	// Publish a message | ||||||
|  | 	subs, receivers := bb.Publish("hello") | ||||||
|  | 	if subs != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 subscriber, got %d", subs) | ||||||
|  | 	} | ||||||
|  | 	if receivers != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 receiver, got %d", receivers) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Verify the message was received | ||||||
|  | 	select { | ||||||
|  | 	case msg := <-ch: | ||||||
|  | 		if msg != "hello" { | ||||||
|  | 			t.Fatalf("Expected to receive 'hello', got '%s'", msg) | ||||||
|  | 		} | ||||||
|  | 	case <-time.After(time.Second): | ||||||
|  | 		t.Fatal("Timed out waiting for message") | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Unsubscribe | ||||||
|  | 	sub.Unsubscribe() | ||||||
|  |  | ||||||
|  | 	// Publish again | ||||||
|  | 	subs, receivers = bb.Publish("after-unsub") | ||||||
|  | 	if subs != 0 { | ||||||
|  | 		t.Fatalf("Expected 0 subscribers after unsubscribe, got %d", subs) | ||||||
|  | 	} | ||||||
|  | 	if receivers != 0 { | ||||||
|  | 		t.Fatalf("Expected 0 receivers after unsubscribe, got %d", receivers) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Check that the subscriber count is 0 | ||||||
|  | 	if bb.SubscriberCount() != 0 { | ||||||
|  | 		t.Fatalf("Expected SubscriberCount() == 0, got %d", bb.SubscriberCount()) | ||||||
|  | 	} | ||||||
|  | } | ||||||
| @@ -115,6 +115,9 @@ func (b *bufferedReadCloser) BufferedAll() ([]byte, error) { | |||||||
| 				return nil, err | 				return nil, err | ||||||
| 			} | 			} | ||||||
| 		} | 		} | ||||||
|  | 		if err := b.Reset(); err != nil { | ||||||
|  | 			return nil, err | ||||||
|  | 		} | ||||||
| 		return b.buffer, nil | 		return b.buffer, nil | ||||||
|  |  | ||||||
| 	case modeSourceFinished: | 	case modeSourceFinished: | ||||||
| @@ -131,10 +134,22 @@ func (b *bufferedReadCloser) BufferedAll() ([]byte, error) { | |||||||
| 	} | 	} | ||||||
| } | } | ||||||
|  |  | ||||||
|  | // Reset resets the buffer to the beginning of the buffer. | ||||||
|  | // If the original source is partially read, we will finish reading it and fill our buffer | ||||||
| func (b *bufferedReadCloser) Reset() error { | func (b *bufferedReadCloser) Reset() error { | ||||||
| 	switch b.mode { | 	switch b.mode { | ||||||
| 	case modeSourceReading: | 	case modeSourceReading: | ||||||
| 		fallthrough | 		if b.off == 0 { | ||||||
|  | 			return nil // nobody has read anything yet | ||||||
|  | 		} | ||||||
|  | 		err := b.Close() | ||||||
|  | 		if err != nil { | ||||||
|  | 			return err | ||||||
|  | 		} | ||||||
|  | 		b.mode = modeBufferReading | ||||||
|  | 		b.off = 0 | ||||||
|  | 		return nil | ||||||
|  |  | ||||||
| 	case modeSourceFinished: | 	case modeSourceFinished: | ||||||
| 		err := b.Close() | 		err := b.Close() | ||||||
| 		if err != nil { | 		if err != nil { | ||||||
|   | |||||||
							
								
								
									
										254
									
								
								dataext/casMutex.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										254
									
								
								dataext/casMutex.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,254 @@ | |||||||
|  | package dataext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"context" | ||||||
|  | 	"golang.org/x/sync/semaphore" | ||||||
|  | 	"runtime" | ||||||
|  | 	"sync" | ||||||
|  | 	"sync/atomic" | ||||||
|  | 	"time" | ||||||
|  | 	"unsafe" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | // from https://github.com/viney-shih/go-lock/blob/2f19fd8ce335e33e0ab9dccb1ff2ce820c3da332/cas.go | ||||||
|  |  | ||||||
|  | // CASMutex is the struct implementing RWMutex with CAS mechanism. | ||||||
|  | type CASMutex struct { | ||||||
|  | 	state     casState | ||||||
|  | 	turnstile *semaphore.Weighted | ||||||
|  |  | ||||||
|  | 	broadcastChan chan struct{} | ||||||
|  | 	broadcastMut  sync.RWMutex | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewCASMutex() *CASMutex { | ||||||
|  | 	return &CASMutex{ | ||||||
|  | 		state:         casStateNoLock, | ||||||
|  | 		turnstile:     semaphore.NewWeighted(1), | ||||||
|  | 		broadcastChan: make(chan struct{}), | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type casState int32 | ||||||
|  |  | ||||||
|  | const ( | ||||||
|  | 	casStateUndefined casState = iota - 2 // -2 | ||||||
|  | 	casStateWriteLock                     // -1 | ||||||
|  | 	casStateNoLock                        // 0 | ||||||
|  | 	casStateReadLock                      // >= 1 | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | func (m *CASMutex) getState(n int32) casState { | ||||||
|  | 	switch st := casState(n); { | ||||||
|  | 	case st == casStateWriteLock: | ||||||
|  | 		fallthrough | ||||||
|  | 	case st == casStateNoLock: | ||||||
|  | 		return st | ||||||
|  | 	case st >= casStateReadLock: | ||||||
|  | 		return casStateReadLock | ||||||
|  | 	default: | ||||||
|  | 		// actually, it should not happened. | ||||||
|  | 		return casStateUndefined | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (m *CASMutex) listen() <-chan struct{} { | ||||||
|  | 	m.broadcastMut.RLock() | ||||||
|  | 	defer m.broadcastMut.RUnlock() | ||||||
|  |  | ||||||
|  | 	return m.broadcastChan | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (m *CASMutex) broadcast() { | ||||||
|  | 	newCh := make(chan struct{}) | ||||||
|  |  | ||||||
|  | 	m.broadcastMut.Lock() | ||||||
|  | 	ch := m.broadcastChan | ||||||
|  | 	m.broadcastChan = newCh | ||||||
|  | 	m.broadcastMut.Unlock() | ||||||
|  |  | ||||||
|  | 	close(ch) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (m *CASMutex) tryLock(ctx context.Context) bool { | ||||||
|  | 	for { | ||||||
|  | 		broker := m.listen() | ||||||
|  | 		if atomic.CompareAndSwapInt32( | ||||||
|  | 			(*int32)(unsafe.Pointer(&m.state)), | ||||||
|  | 			int32(casStateNoLock), | ||||||
|  | 			int32(casStateWriteLock), | ||||||
|  | 		) { | ||||||
|  | 			return true | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		if ctx == nil { | ||||||
|  | 			return false | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		select { | ||||||
|  | 		case <-ctx.Done(): | ||||||
|  | 			// timeout or cancellation | ||||||
|  | 			return false | ||||||
|  | 		case <-broker: | ||||||
|  | 			// waiting for signal triggered by m.broadcast() and trying again. | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // TryLockWithContext attempts to acquire the lock, blocking until resources | ||||||
|  | // are available or ctx is done (timeout or cancellation). | ||||||
|  | func (m *CASMutex) TryLockWithContext(ctx context.Context) bool { | ||||||
|  | 	if err := m.turnstile.Acquire(ctx, 1); err != nil { | ||||||
|  | 		// Acquire failed due to timeout or cancellation | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	defer m.turnstile.Release(1) | ||||||
|  |  | ||||||
|  | 	return m.tryLock(ctx) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // Lock acquires the lock. | ||||||
|  | // If it is currently held by others, Lock will wait until it has a chance to acquire it. | ||||||
|  | func (m *CASMutex) Lock() { | ||||||
|  | 	ctx := context.Background() | ||||||
|  |  | ||||||
|  | 	m.TryLockWithContext(ctx) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // TryLock attempts to acquire the lock without blocking. | ||||||
|  | // Return false if someone is holding it now. | ||||||
|  | func (m *CASMutex) TryLock() bool { | ||||||
|  | 	if !m.turnstile.TryAcquire(1) { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	defer m.turnstile.Release(1) | ||||||
|  |  | ||||||
|  | 	return m.tryLock(nil) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // TryLockWithTimeout attempts to acquire the lock within a period of time. | ||||||
|  | // Return false if spending time is more than duration and no chance to acquire it. | ||||||
|  | func (m *CASMutex) TryLockWithTimeout(duration time.Duration) bool { | ||||||
|  | 	ctx, cancel := context.WithTimeout(context.Background(), duration) | ||||||
|  | 	defer cancel() | ||||||
|  |  | ||||||
|  | 	return m.TryLockWithContext(ctx) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // Unlock releases the lock. | ||||||
|  | func (m *CASMutex) Unlock() { | ||||||
|  | 	if ok := atomic.CompareAndSwapInt32( | ||||||
|  | 		(*int32)(unsafe.Pointer(&m.state)), | ||||||
|  | 		int32(casStateWriteLock), | ||||||
|  | 		int32(casStateNoLock), | ||||||
|  | 	); !ok { | ||||||
|  | 		panic("Unlock failed") | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	m.broadcast() | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (m *CASMutex) rTryLock(ctx context.Context) bool { | ||||||
|  | 	for { | ||||||
|  | 		broker := m.listen() | ||||||
|  | 		n := atomic.LoadInt32((*int32)(unsafe.Pointer(&m.state))) | ||||||
|  | 		st := m.getState(n) | ||||||
|  | 		switch st { | ||||||
|  | 		case casStateNoLock, casStateReadLock: | ||||||
|  | 			if atomic.CompareAndSwapInt32((*int32)(unsafe.Pointer(&m.state)), n, n+1) { | ||||||
|  | 				return true | ||||||
|  | 			} | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		if ctx == nil { | ||||||
|  | 			return false | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		select { | ||||||
|  | 		case <-ctx.Done(): | ||||||
|  | 			// timeout or cancellation | ||||||
|  | 			return false | ||||||
|  | 		default: | ||||||
|  | 			switch st { | ||||||
|  | 			// read-lock failed due to concurrence issue, try again immediately | ||||||
|  | 			case casStateNoLock, casStateReadLock: | ||||||
|  | 				runtime.Gosched() // allow other goroutines to do stuff. | ||||||
|  | 				continue | ||||||
|  | 			} | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		select { | ||||||
|  | 		case <-ctx.Done(): | ||||||
|  | 			// timeout or cancellation | ||||||
|  | 			return false | ||||||
|  | 		case <-broker: | ||||||
|  | 			// waiting for signal triggered by m.broadcast() and trying again. | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // RTryLockWithContext attempts to acquire the read lock, blocking until resources | ||||||
|  | // are available or ctx is done (timeout or cancellation). | ||||||
|  | func (m *CASMutex) RTryLockWithContext(ctx context.Context) bool { | ||||||
|  | 	if err := m.turnstile.Acquire(ctx, 1); err != nil { | ||||||
|  | 		// Acquire failed due to timeout or cancellation | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	m.turnstile.Release(1) | ||||||
|  |  | ||||||
|  | 	return m.rTryLock(ctx) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // RLock acquires the read lock. | ||||||
|  | // If it is currently held by others writing, RLock will wait until it has a chance to acquire it. | ||||||
|  | func (m *CASMutex) RLock() { | ||||||
|  | 	ctx := context.Background() | ||||||
|  |  | ||||||
|  | 	m.RTryLockWithContext(ctx) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // RTryLock attempts to acquire the read lock without blocking. | ||||||
|  | // Return false if someone is writing it now. | ||||||
|  | func (m *CASMutex) RTryLock() bool { | ||||||
|  | 	if !m.turnstile.TryAcquire(1) { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	m.turnstile.Release(1) | ||||||
|  |  | ||||||
|  | 	return m.rTryLock(nil) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // RTryLockWithTimeout attempts to acquire the read lock within a period of time. | ||||||
|  | // Return false if spending time is more than duration and no chance to acquire it. | ||||||
|  | func (m *CASMutex) RTryLockWithTimeout(duration time.Duration) bool { | ||||||
|  | 	ctx, cancel := context.WithTimeout(context.Background(), duration) | ||||||
|  | 	defer cancel() | ||||||
|  |  | ||||||
|  | 	return m.RTryLockWithContext(ctx) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // RUnlock releases the read lock. | ||||||
|  | func (m *CASMutex) RUnlock() { | ||||||
|  | 	n := atomic.AddInt32((*int32)(unsafe.Pointer(&m.state)), -1) | ||||||
|  | 	switch m.getState(n) { | ||||||
|  | 	case casStateUndefined, casStateWriteLock: | ||||||
|  | 		panic("RUnlock failed") | ||||||
|  | 	case casStateNoLock: | ||||||
|  | 		m.broadcast() | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // RLocker returns a Locker interface that implements the Lock and Unlock methods | ||||||
|  | // by calling CASMutex.RLock and CASMutex.RUnlock. | ||||||
|  | func (m *CASMutex) RLocker() sync.Locker { | ||||||
|  | 	return (*rlocker)(m) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type rlocker CASMutex | ||||||
|  |  | ||||||
|  | func (r *rlocker) Lock()   { (*CASMutex)(r).RLock() } | ||||||
|  | func (r *rlocker) Unlock() { (*CASMutex)(r).RUnlock() } | ||||||
							
								
								
									
										202
									
								
								dataext/delayedCombiningInvoker.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										202
									
								
								dataext/delayedCombiningInvoker.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,202 @@ | |||||||
|  | package dataext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"context" | ||||||
|  | 	"sync" | ||||||
|  | 	"time" | ||||||
|  |  | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/syncext" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | // DelayedCombiningInvoker is a utility to combine multiple consecutive requests into a single execution | ||||||
|  | // | ||||||
|  | // Requests are made with Request(), and consecutive requests are combined during the `delay` period. | ||||||
|  | // | ||||||
|  | // Can be used, e.g., for search-controls, where we want to init the search when teh user stops typing | ||||||
|  | // Or generally to queue an execution once a burst of requests is over. | ||||||
|  | type DelayedCombiningInvoker struct { | ||||||
|  | 	syncLock           sync.Mutex | ||||||
|  | 	triggerChan        chan bool | ||||||
|  | 	cancelChan         chan bool | ||||||
|  | 	execNowChan        chan bool | ||||||
|  | 	action             func() | ||||||
|  | 	delay              time.Duration | ||||||
|  | 	maxDelay           time.Duration | ||||||
|  | 	executorRunning    *syncext.AtomicBool | ||||||
|  | 	pendingRequests    *syncext.Atomic[int] | ||||||
|  | 	lastRequestTime    time.Time | ||||||
|  | 	initialRequestTime time.Time | ||||||
|  |  | ||||||
|  | 	onExecutionStart []func(immediately bool)          // listener ( actual execution of action starts ) | ||||||
|  | 	onExecutionDone  []func()                          // listener ( actual execution of action finished ) | ||||||
|  | 	onRequest        []func(pending int, initial bool) // listener ( a request came in, waiting for execution ) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewDelayedCombiningInvoker(action func(), delay time.Duration, maxDelay time.Duration) *DelayedCombiningInvoker { | ||||||
|  | 	return &DelayedCombiningInvoker{ | ||||||
|  | 		action:             action, | ||||||
|  | 		delay:              delay, | ||||||
|  | 		maxDelay:           maxDelay, | ||||||
|  | 		executorRunning:    syncext.NewAtomicBool(false), | ||||||
|  | 		pendingRequests:    syncext.NewAtomic[int](0), | ||||||
|  | 		triggerChan:        make(chan bool), | ||||||
|  | 		cancelChan:         make(chan bool, 1), | ||||||
|  | 		execNowChan:        make(chan bool, 1), | ||||||
|  | 		lastRequestTime:    time.Now(), | ||||||
|  | 		initialRequestTime: time.Now(), | ||||||
|  | 		onExecutionStart:   make([]func(bool), 0), | ||||||
|  | 		onExecutionDone:    make([]func(), 0), | ||||||
|  | 		onRequest:          make([]func(int, bool), 0), | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (d *DelayedCombiningInvoker) Request() { | ||||||
|  | 	now := time.Now() | ||||||
|  |  | ||||||
|  | 	d.syncLock.Lock() | ||||||
|  | 	defer d.syncLock.Unlock() | ||||||
|  |  | ||||||
|  | 	if d.executorRunning.Get() { | ||||||
|  | 		d.lastRequestTime = now | ||||||
|  | 		d.pendingRequests.Update(func(v int) int { return v + 1 }) | ||||||
|  |  | ||||||
|  | 		for _, fn := range d.onRequest { | ||||||
|  | 			_ = langext.RunPanicSafe(func() { fn(d.pendingRequests.Get(), true) }) | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		d.triggerChan <- true | ||||||
|  | 	} else { | ||||||
|  | 		d.initialRequestTime = now | ||||||
|  | 		d.lastRequestTime = now | ||||||
|  |  | ||||||
|  | 		d.executorRunning.Set(true) | ||||||
|  | 		d.pendingRequests.Set(1) | ||||||
|  | 		syncext.ReadNonBlocking(d.triggerChan) // clear the channel | ||||||
|  | 		syncext.ReadNonBlocking(d.cancelChan)  // clear the channel | ||||||
|  | 		syncext.ReadNonBlocking(d.execNowChan) // clear the channel | ||||||
|  |  | ||||||
|  | 		for _, fn := range d.onRequest { | ||||||
|  | 			_ = langext.RunPanicSafe(func() { fn(d.pendingRequests.Get(), false) }) | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		go d.run() | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (d *DelayedCombiningInvoker) run() { | ||||||
|  |  | ||||||
|  | 	needsExecutorRunningCleanup := true | ||||||
|  | 	defer func() { | ||||||
|  | 		if needsExecutorRunningCleanup { | ||||||
|  | 			d.syncLock.Lock() | ||||||
|  | 			d.executorRunning.Set(false) | ||||||
|  | 			d.syncLock.Unlock() | ||||||
|  | 		} | ||||||
|  | 	}() | ||||||
|  |  | ||||||
|  | 	for { | ||||||
|  | 		d.syncLock.Lock() | ||||||
|  | 		timeOut := min(d.maxDelay-time.Since(d.initialRequestTime), d.delay-time.Since(d.lastRequestTime)) | ||||||
|  | 		if timeOut < 0 { | ||||||
|  | 			timeOut = 0 | ||||||
|  | 		} | ||||||
|  | 		d.syncLock.Unlock() | ||||||
|  |  | ||||||
|  | 		immediately := false | ||||||
|  |  | ||||||
|  | 		select { | ||||||
|  | 		case <-d.execNowChan: | ||||||
|  | 			// run immediately | ||||||
|  | 			immediately = true | ||||||
|  | 			break | ||||||
|  | 		case <-d.triggerChan: | ||||||
|  | 			// external trigger - needs to re-evaluate | ||||||
|  | 			break | ||||||
|  | 		case <-d.cancelChan: | ||||||
|  | 			// cancel | ||||||
|  | 			return | ||||||
|  | 		case <-time.After(timeOut): | ||||||
|  | 			// time elapsed - check for execution | ||||||
|  | 			break | ||||||
|  |  | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		d.syncLock.Lock() | ||||||
|  | 		execute := immediately || time.Since(d.lastRequestTime) >= d.delay || time.Since(d.initialRequestTime) >= d.maxDelay | ||||||
|  | 		if !execute { | ||||||
|  | 			d.syncLock.Unlock() | ||||||
|  | 			continue | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		d.pendingRequests.Set(0) | ||||||
|  |  | ||||||
|  | 		for _, fn := range d.onExecutionStart { | ||||||
|  | 			_ = langext.RunPanicSafe(func() { fn(immediately) }) | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		// ================================================= | ||||||
|  | 		_ = langext.RunPanicSafe(d.action) | ||||||
|  | 		// ================================================= | ||||||
|  |  | ||||||
|  | 		d.executorRunning.Set(false) // ensure HasPendingRequests returns fals ein onExecutionDone listener | ||||||
|  | 		needsExecutorRunningCleanup = false | ||||||
|  |  | ||||||
|  | 		for _, fn := range d.onExecutionDone { | ||||||
|  | 			_ = langext.RunPanicSafe(fn) | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		d.syncLock.Unlock() | ||||||
|  |  | ||||||
|  | 		return | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (d *DelayedCombiningInvoker) CancelPendingRequests() { | ||||||
|  | 	d.syncLock.Lock() | ||||||
|  | 	defer d.syncLock.Unlock() | ||||||
|  |  | ||||||
|  | 	syncext.WriteNonBlocking(d.cancelChan, true) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (d *DelayedCombiningInvoker) HasPendingRequests() bool { | ||||||
|  | 	return d.executorRunning.Get() | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (d *DelayedCombiningInvoker) CountPendingRequests() int { | ||||||
|  | 	return d.pendingRequests.Get() | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (d *DelayedCombiningInvoker) ExecuteNow() bool { | ||||||
|  | 	d.syncLock.Lock() | ||||||
|  | 	defer d.syncLock.Unlock() | ||||||
|  |  | ||||||
|  | 	if d.executorRunning.Get() { | ||||||
|  | 		syncext.WriteNonBlocking(d.execNowChan, true) | ||||||
|  | 		return true | ||||||
|  | 	} else { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (d *DelayedCombiningInvoker) WaitForCompletion(ctx context.Context) error { | ||||||
|  | 	return d.executorRunning.WaitWithContext(ctx, false) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (d *DelayedCombiningInvoker) RegisterOnExecutionStart(fn func(immediately bool)) { | ||||||
|  | 	d.syncLock.Lock() | ||||||
|  | 	defer d.syncLock.Unlock() | ||||||
|  | 	d.onExecutionStart = append(d.onExecutionStart, fn) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (d *DelayedCombiningInvoker) RegisterOnExecutionDone(fn func()) { | ||||||
|  | 	d.syncLock.Lock() | ||||||
|  | 	defer d.syncLock.Unlock() | ||||||
|  | 	d.onExecutionDone = append(d.onExecutionDone, fn) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (d *DelayedCombiningInvoker) RegisterOnRequest(fn func(pending int, initial bool)) { | ||||||
|  | 	d.syncLock.Lock() | ||||||
|  | 	defer d.syncLock.Unlock() | ||||||
|  | 	d.onRequest = append(d.onRequest, fn) | ||||||
|  | } | ||||||
| @@ -1,7 +1,7 @@ | |||||||
| package dataext | package dataext | ||||||
|  |  | ||||||
| import ( | import ( | ||||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/langext" | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
| 	"math/rand" | 	"math/rand" | ||||||
| 	"strconv" | 	"strconv" | ||||||
| 	"testing" | 	"testing" | ||||||
| @@ -12,7 +12,7 @@ func init() { | |||||||
| } | } | ||||||
|  |  | ||||||
| func TestResultCache1(t *testing.T) { | func TestResultCache1(t *testing.T) { | ||||||
| 	cache := NewLRUMap[string](8) | 	cache := NewLRUMap[string, string](8) | ||||||
| 	verifyLRUList(cache, t) | 	verifyLRUList(cache, t) | ||||||
|  |  | ||||||
| 	key := randomKey() | 	key := randomKey() | ||||||
| @@ -50,7 +50,7 @@ func TestResultCache1(t *testing.T) { | |||||||
| } | } | ||||||
|  |  | ||||||
| func TestResultCache2(t *testing.T) { | func TestResultCache2(t *testing.T) { | ||||||
| 	cache := NewLRUMap[string](8) | 	cache := NewLRUMap[string, string](8) | ||||||
| 	verifyLRUList(cache, t) | 	verifyLRUList(cache, t) | ||||||
|  |  | ||||||
| 	key1 := "key1" | 	key1 := "key1" | ||||||
| @@ -150,7 +150,7 @@ func TestResultCache2(t *testing.T) { | |||||||
| } | } | ||||||
|  |  | ||||||
| func TestResultCache3(t *testing.T) { | func TestResultCache3(t *testing.T) { | ||||||
| 	cache := NewLRUMap[string](8) | 	cache := NewLRUMap[string, string](8) | ||||||
| 	verifyLRUList(cache, t) | 	verifyLRUList(cache, t) | ||||||
|  |  | ||||||
| 	key1 := "key1" | 	key1 := "key1" | ||||||
| @@ -173,7 +173,7 @@ func TestResultCache3(t *testing.T) { | |||||||
| } | } | ||||||
|  |  | ||||||
| // does a basic consistency check over the internal cache representation | // does a basic consistency check over the internal cache representation | ||||||
| func verifyLRUList[TData any](cache *LRUMap[TData], t *testing.T) { | func verifyLRUList[TKey comparable, TData any](cache *LRUMap[TKey, TData], t *testing.T) { | ||||||
| 	size := 0 | 	size := 0 | ||||||
|  |  | ||||||
| 	tailFound := false | 	tailFound := false | ||||||
|   | |||||||
| @@ -1,7 +1,8 @@ | |||||||
| package dataext | package dataext | ||||||
|  |  | ||||||
| import ( | import ( | ||||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/langext" | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/tst" | ||||||
| 	"testing" | 	"testing" | ||||||
| ) | ) | ||||||
|  |  | ||||||
| @@ -43,10 +44,10 @@ func TestObjectMerge(t *testing.T) { | |||||||
|  |  | ||||||
| 	valueMerge := ObjectMerge(valueA, valueB) | 	valueMerge := ObjectMerge(valueA, valueB) | ||||||
|  |  | ||||||
| 	assertPtrEqual(t, "Field1", valueMerge.Field1, valueB.Field1) | 	tst.AssertIdentPtrEqual(t, "Field1", valueMerge.Field1, valueB.Field1) | ||||||
| 	assertPtrEqual(t, "Field2", valueMerge.Field2, valueA.Field2) | 	tst.AssertIdentPtrEqual(t, "Field2", valueMerge.Field2, valueA.Field2) | ||||||
| 	assertPtrEqual(t, "Field3", valueMerge.Field3, valueB.Field3) | 	tst.AssertIdentPtrEqual(t, "Field3", valueMerge.Field3, valueB.Field3) | ||||||
| 	assertPtrEqual(t, "Field4", valueMerge.Field4, nil) | 	tst.AssertIdentPtrEqual(t, "Field4", valueMerge.Field4, nil) | ||||||
|  |  | ||||||
| } | } | ||||||
|  |  | ||||||
|   | |||||||
							
								
								
									
										83
									
								
								dataext/optional.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										83
									
								
								dataext/optional.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,83 @@ | |||||||
|  | package dataext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"encoding/json" | ||||||
|  | 	"errors" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | type JsonOpt[T any] struct { | ||||||
|  | 	isSet bool | ||||||
|  | 	value T | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewJsonOpt[T any](v T) JsonOpt[T] { | ||||||
|  | 	return JsonOpt[T]{isSet: true, value: v} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func EmptyJsonOpt[T any]() JsonOpt[T] { | ||||||
|  | 	return JsonOpt[T]{isSet: false} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // MarshalJSON returns m as the JSON encoding of m. | ||||||
|  | func (m JsonOpt[T]) MarshalJSON() ([]byte, error) { | ||||||
|  | 	if !m.isSet { | ||||||
|  | 		return []byte("null"), nil // actually this would be undefined - but undefined is not valid JSON | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return json.Marshal(m.value) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // UnmarshalJSON sets *m to a copy of data. | ||||||
|  | func (m *JsonOpt[T]) UnmarshalJSON(data []byte) error { | ||||||
|  | 	if m == nil { | ||||||
|  | 		return errors.New("JsonOpt: UnmarshalJSON on nil pointer") | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	m.isSet = true | ||||||
|  | 	return json.Unmarshal(data, &m.value) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (m JsonOpt[T]) IsSet() bool { | ||||||
|  | 	return m.isSet | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (m JsonOpt[T]) IsUnset() bool { | ||||||
|  | 	return !m.isSet | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (m JsonOpt[T]) Value() (T, bool) { | ||||||
|  | 	if !m.isSet { | ||||||
|  | 		return *new(T), false | ||||||
|  | 	} | ||||||
|  | 	return m.value, true | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (m JsonOpt[T]) ValueOrNil() *T { | ||||||
|  | 	if !m.isSet { | ||||||
|  | 		return nil | ||||||
|  | 	} | ||||||
|  | 	return &m.value | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (m JsonOpt[T]) ValueDblPtrOrNil() **T { | ||||||
|  | 	if !m.isSet { | ||||||
|  | 		return nil | ||||||
|  | 	} | ||||||
|  | 	return langext.DblPtr(m.value) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (m JsonOpt[T]) MustValue() T { | ||||||
|  | 	if !m.isSet { | ||||||
|  | 		panic("value not set") | ||||||
|  | 	} | ||||||
|  | 	return m.value | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (m JsonOpt[T]) IfSet(fn func(v T)) bool { | ||||||
|  | 	if !m.isSet { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  | 	fn(m.value) | ||||||
|  | 	return true | ||||||
|  | } | ||||||
							
								
								
									
										241
									
								
								dataext/pubsub.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										241
									
								
								dataext/pubsub.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,241 @@ | |||||||
|  | package dataext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"context" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/syncext" | ||||||
|  | 	"github.com/rs/xid" | ||||||
|  | 	"iter" | ||||||
|  | 	"sync" | ||||||
|  | 	"time" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | // PubSub is a simple Pub/Sub Broker | ||||||
|  | // Clients can subscribe to a namespace and receive published messages on this namespace | ||||||
|  | // Messages are broadcast to all subscribers | ||||||
|  | type PubSub[TNamespace comparable, TData any] struct { | ||||||
|  | 	masterLock *sync.Mutex | ||||||
|  |  | ||||||
|  | 	subscriptions map[TNamespace][]*pubSubSubscription[TNamespace, TData] | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type PubSubSubscription interface { | ||||||
|  | 	Unsubscribe() | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type pubSubSubscription[TNamespace comparable, TData any] struct { | ||||||
|  | 	ID string | ||||||
|  |  | ||||||
|  | 	parent    *PubSub[TNamespace, TData] | ||||||
|  | 	namespace TNamespace | ||||||
|  |  | ||||||
|  | 	subLock *sync.Mutex | ||||||
|  |  | ||||||
|  | 	Func func(TData) | ||||||
|  | 	Chan chan TData | ||||||
|  |  | ||||||
|  | 	UnsubChan chan bool | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (p *pubSubSubscription[TNamespace, TData]) Unsubscribe() { | ||||||
|  | 	p.parent.unsubscribe(p) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewPubSub[TNamespace comparable, TData any](capacity int) *PubSub[TNamespace, TData] { | ||||||
|  | 	return &PubSub[TNamespace, TData]{ | ||||||
|  | 		masterLock:    &sync.Mutex{}, | ||||||
|  | 		subscriptions: make(map[TNamespace][]*pubSubSubscription[TNamespace, TData], capacity), | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ps *PubSub[TNamespace, TData]) Namespaces() []TNamespace { | ||||||
|  | 	ps.masterLock.Lock() | ||||||
|  | 	defer ps.masterLock.Unlock() | ||||||
|  |  | ||||||
|  | 	return langext.MapKeyArr(ps.subscriptions) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ps *PubSub[TNamespace, TData]) SubscriberCount(ns TNamespace) int { | ||||||
|  | 	ps.masterLock.Lock() | ||||||
|  | 	defer ps.masterLock.Unlock() | ||||||
|  |  | ||||||
|  | 	return len(ps.subscriptions[ns]) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // Publish sends `data` to all subscriber | ||||||
|  | // But unbuffered - if one is currently not listening, we skip (the actualReceiver < subscriber) | ||||||
|  | func (ps *PubSub[TNamespace, TData]) Publish(ns TNamespace, data TData) (subscriber int, actualReceiver int) { | ||||||
|  | 	ps.masterLock.Lock() | ||||||
|  | 	subs := langext.ArrCopy(ps.subscriptions[ns]) | ||||||
|  | 	ps.masterLock.Unlock() | ||||||
|  |  | ||||||
|  | 	subscriber = len(subs) | ||||||
|  | 	actualReceiver = 0 | ||||||
|  |  | ||||||
|  | 	for _, sub := range subs { | ||||||
|  | 		func() { | ||||||
|  | 			sub.subLock.Lock() | ||||||
|  | 			defer sub.subLock.Unlock() | ||||||
|  |  | ||||||
|  | 			if sub.Func != nil { | ||||||
|  | 				go func() { sub.Func(data) }() | ||||||
|  | 				actualReceiver++ | ||||||
|  | 			} else if sub.Chan != nil { | ||||||
|  | 				msgSent := syncext.WriteNonBlocking(sub.Chan, data) | ||||||
|  | 				if msgSent { | ||||||
|  | 					actualReceiver++ | ||||||
|  | 				} | ||||||
|  | 			} | ||||||
|  | 		}() | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return subscriber, actualReceiver | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // PublishWithContext sends `data` to all subscriber | ||||||
|  | // buffered - if one is currently not listening, we wait (but error out when the context runs out) | ||||||
|  | func (ps *PubSub[TNamespace, TData]) PublishWithContext(ctx context.Context, ns TNamespace, data TData) (subscriber int, actualReceiver int, err error) { | ||||||
|  | 	ps.masterLock.Lock() | ||||||
|  | 	subs := langext.ArrCopy(ps.subscriptions[ns]) | ||||||
|  | 	ps.masterLock.Unlock() | ||||||
|  |  | ||||||
|  | 	subscriber = len(subs) | ||||||
|  | 	actualReceiver = 0 | ||||||
|  |  | ||||||
|  | 	for _, sub := range subs { | ||||||
|  | 		err := func() error { | ||||||
|  | 			sub.subLock.Lock() | ||||||
|  | 			defer sub.subLock.Unlock() | ||||||
|  |  | ||||||
|  | 			if err := ctx.Err(); err != nil { | ||||||
|  | 				return err | ||||||
|  | 			} | ||||||
|  |  | ||||||
|  | 			if sub.Func != nil { | ||||||
|  | 				go func() { sub.Func(data) }() | ||||||
|  | 				actualReceiver++ | ||||||
|  | 			} else if sub.Chan != nil { | ||||||
|  | 				err := syncext.WriteChannelWithContext(ctx, sub.Chan, data) | ||||||
|  | 				if err != nil { | ||||||
|  | 					return err | ||||||
|  | 				} | ||||||
|  | 				actualReceiver++ | ||||||
|  | 			} | ||||||
|  |  | ||||||
|  | 			return nil | ||||||
|  | 		}() | ||||||
|  | 		if err != nil { | ||||||
|  | 			return subscriber, actualReceiver, err | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return subscriber, actualReceiver, nil | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // PublishWithTimeout sends `data` to all subscriber | ||||||
|  | // buffered - if one is currently not listening, we wait (but wait at most `timeout` - if the timeout is exceeded then actualReceiver < subscriber) | ||||||
|  | func (ps *PubSub[TNamespace, TData]) PublishWithTimeout(ns TNamespace, data TData, timeout time.Duration) (subscriber int, actualReceiver int) { | ||||||
|  | 	ps.masterLock.Lock() | ||||||
|  | 	subs := langext.ArrCopy(ps.subscriptions[ns]) | ||||||
|  | 	ps.masterLock.Unlock() | ||||||
|  |  | ||||||
|  | 	subscriber = len(subs) | ||||||
|  | 	actualReceiver = 0 | ||||||
|  |  | ||||||
|  | 	for _, sub := range subs { | ||||||
|  | 		func() { | ||||||
|  | 			sub.subLock.Lock() | ||||||
|  | 			defer sub.subLock.Unlock() | ||||||
|  |  | ||||||
|  | 			if sub.Func != nil { | ||||||
|  | 				go func() { sub.Func(data) }() | ||||||
|  | 				actualReceiver++ | ||||||
|  | 			} else if sub.Chan != nil { | ||||||
|  | 				ok := syncext.WriteChannelWithTimeout(sub.Chan, data, timeout) | ||||||
|  | 				if ok { | ||||||
|  | 					actualReceiver++ | ||||||
|  | 				} | ||||||
|  | 			} | ||||||
|  | 		}() | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return subscriber, actualReceiver | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ps *PubSub[TNamespace, TData]) SubscribeByCallback(ns TNamespace, fn func(TData)) PubSubSubscription { | ||||||
|  | 	ps.masterLock.Lock() | ||||||
|  | 	defer ps.masterLock.Unlock() | ||||||
|  |  | ||||||
|  | 	sub := &pubSubSubscription[TNamespace, TData]{ID: xid.New().String(), namespace: ns, parent: ps, subLock: &sync.Mutex{}, Func: fn, UnsubChan: nil} | ||||||
|  |  | ||||||
|  | 	ps.subscriptions[ns] = append(ps.subscriptions[ns], sub) | ||||||
|  |  | ||||||
|  | 	return sub | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ps *PubSub[TNamespace, TData]) SubscribeByChan(ns TNamespace, chanBufferSize int) (chan TData, PubSubSubscription) { | ||||||
|  | 	ps.masterLock.Lock() | ||||||
|  | 	defer ps.masterLock.Unlock() | ||||||
|  |  | ||||||
|  | 	msgCh := make(chan TData, chanBufferSize) | ||||||
|  |  | ||||||
|  | 	sub := &pubSubSubscription[TNamespace, TData]{ID: xid.New().String(), namespace: ns, parent: ps, subLock: &sync.Mutex{}, Chan: msgCh, UnsubChan: nil} | ||||||
|  |  | ||||||
|  | 	ps.subscriptions[ns] = append(ps.subscriptions[ns], sub) | ||||||
|  |  | ||||||
|  | 	return msgCh, sub | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ps *PubSub[TNamespace, TData]) SubscribeByIter(ns TNamespace, chanBufferSize int) (iter.Seq[TData], PubSubSubscription) { | ||||||
|  | 	ps.masterLock.Lock() | ||||||
|  | 	defer ps.masterLock.Unlock() | ||||||
|  |  | ||||||
|  | 	msgCh := make(chan TData, chanBufferSize) | ||||||
|  | 	unsubChan := make(chan bool, 8) | ||||||
|  |  | ||||||
|  | 	sub := &pubSubSubscription[TNamespace, TData]{ID: xid.New().String(), namespace: ns, parent: ps, subLock: &sync.Mutex{}, Chan: msgCh, UnsubChan: unsubChan} | ||||||
|  |  | ||||||
|  | 	ps.subscriptions[ns] = append(ps.subscriptions[ns], sub) | ||||||
|  |  | ||||||
|  | 	iterFun := func(yield func(TData) bool) { | ||||||
|  | 		for { | ||||||
|  | 			select { | ||||||
|  | 			case msg := <-msgCh: | ||||||
|  | 				if !yield(msg) { | ||||||
|  | 					sub.Unsubscribe() | ||||||
|  | 					return | ||||||
|  | 				} | ||||||
|  | 			case <-sub.UnsubChan: | ||||||
|  | 				sub.Unsubscribe() | ||||||
|  | 				return | ||||||
|  | 			} | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return iterFun, sub | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ps *PubSub[TNamespace, TData]) unsubscribe(p *pubSubSubscription[TNamespace, TData]) { | ||||||
|  | 	ps.masterLock.Lock() | ||||||
|  | 	defer ps.masterLock.Unlock() | ||||||
|  |  | ||||||
|  | 	p.subLock.Lock() | ||||||
|  | 	defer p.subLock.Unlock() | ||||||
|  |  | ||||||
|  | 	if p.Chan != nil { | ||||||
|  | 		close(p.Chan) | ||||||
|  | 		p.Chan = nil | ||||||
|  | 	} | ||||||
|  | 	if p.UnsubChan != nil { | ||||||
|  | 		syncext.WriteNonBlocking(p.UnsubChan, true) | ||||||
|  | 		close(p.UnsubChan) | ||||||
|  | 		p.UnsubChan = nil | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	ps.subscriptions[p.namespace] = langext.ArrFilter(ps.subscriptions[p.namespace], func(v *pubSubSubscription[TNamespace, TData]) bool { | ||||||
|  | 		return v.ID != p.ID | ||||||
|  | 	}) | ||||||
|  | 	if len(ps.subscriptions[p.namespace]) == 0 { | ||||||
|  | 		delete(ps.subscriptions, p.namespace) | ||||||
|  | 	} | ||||||
|  | } | ||||||
							
								
								
									
										428
									
								
								dataext/pubsub_test.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										428
									
								
								dataext/pubsub_test.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,428 @@ | |||||||
|  | package dataext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"context" | ||||||
|  | 	"sync" | ||||||
|  | 	"testing" | ||||||
|  | 	"time" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | func TestNewPubSub(t *testing.T) { | ||||||
|  | 	ps := NewPubSub[string, string](10) | ||||||
|  | 	if ps == nil { | ||||||
|  | 		t.Fatal("NewPubSub returned nil") | ||||||
|  | 	} | ||||||
|  | 	if ps.masterLock == nil { | ||||||
|  | 		t.Fatal("masterLock is nil") | ||||||
|  | 	} | ||||||
|  | 	if ps.subscriptions == nil { | ||||||
|  | 		t.Fatal("subscriptions is nil") | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestPubSub_Namespaces(t *testing.T) { | ||||||
|  | 	ps := NewPubSub[string, string](10) | ||||||
|  |  | ||||||
|  | 	// Initially no namespaces | ||||||
|  | 	namespaces := ps.Namespaces() | ||||||
|  | 	if len(namespaces) != 0 { | ||||||
|  | 		t.Fatalf("Expected 0 namespaces, got %d", len(namespaces)) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Add a subscription to create a namespace | ||||||
|  | 	_, sub1 := ps.SubscribeByChan("test-ns1", 1) | ||||||
|  | 	defer sub1.Unsubscribe() | ||||||
|  |  | ||||||
|  | 	// Add another subscription to a different namespace | ||||||
|  | 	_, sub2 := ps.SubscribeByChan("test-ns2", 1) | ||||||
|  | 	defer sub2.Unsubscribe() | ||||||
|  |  | ||||||
|  | 	// Check namespaces | ||||||
|  | 	namespaces = ps.Namespaces() | ||||||
|  | 	if len(namespaces) != 2 { | ||||||
|  | 		t.Fatalf("Expected 2 namespaces, got %d", len(namespaces)) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Check if namespaces contain the expected values | ||||||
|  | 	found1, found2 := false, false | ||||||
|  | 	for _, ns := range namespaces { | ||||||
|  | 		if ns == "test-ns1" { | ||||||
|  | 			found1 = true | ||||||
|  | 		} | ||||||
|  | 		if ns == "test-ns2" { | ||||||
|  | 			found2 = true | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if !found1 || !found2 { | ||||||
|  | 		t.Fatalf("Expected to find both namespaces, found ns1: %v, ns2: %v", found1, found2) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestPubSub_SubscribeByCallback(t *testing.T) { | ||||||
|  | 	ps := NewPubSub[string, string](10) | ||||||
|  |  | ||||||
|  | 	var received string | ||||||
|  | 	var wg sync.WaitGroup | ||||||
|  | 	wg.Add(1) | ||||||
|  |  | ||||||
|  | 	callback := func(msg string) { | ||||||
|  | 		received = msg | ||||||
|  | 		wg.Done() | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	sub := ps.SubscribeByCallback("test-ns", callback) | ||||||
|  | 	defer sub.Unsubscribe() | ||||||
|  |  | ||||||
|  | 	// Publish a message | ||||||
|  | 	subs, receivers := ps.Publish("test-ns", "hello") | ||||||
|  |  | ||||||
|  | 	if subs != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 subscriber, got %d", subs) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if receivers != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 receiver, got %d", receivers) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Wait for the callback to be executed | ||||||
|  | 	wg.Wait() | ||||||
|  |  | ||||||
|  | 	if received != "hello" { | ||||||
|  | 		t.Fatalf("Expected to receive 'hello', got '%s'", received) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestPubSub_SubscribeByChan(t *testing.T) { | ||||||
|  | 	ps := NewPubSub[string, string](10) | ||||||
|  |  | ||||||
|  | 	ch, sub := ps.SubscribeByChan("test-ns", 1) | ||||||
|  | 	defer sub.Unsubscribe() | ||||||
|  |  | ||||||
|  | 	// Publish a message | ||||||
|  | 	subs, receivers := ps.Publish("test-ns", "hello") | ||||||
|  |  | ||||||
|  | 	if subs != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 subscriber, got %d", subs) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if receivers != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 receiver, got %d", receivers) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Read from the channel with a timeout to avoid blocking | ||||||
|  | 	select { | ||||||
|  | 	case msg := <-ch: | ||||||
|  | 		if msg != "hello" { | ||||||
|  | 			t.Fatalf("Expected to receive 'hello', got '%s'", msg) | ||||||
|  | 		} | ||||||
|  | 	case <-time.After(time.Second): | ||||||
|  | 		t.Fatal("Timed out waiting for message") | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestPubSub_SubscribeByIter(t *testing.T) { | ||||||
|  | 	ps := NewPubSub[string, string](10) | ||||||
|  |  | ||||||
|  | 	iterSeq, sub := ps.SubscribeByIter("test-ns", 1) | ||||||
|  | 	defer sub.Unsubscribe() | ||||||
|  |  | ||||||
|  | 	// Channel to communicate when message is received | ||||||
|  | 	done := make(chan bool) | ||||||
|  | 	received := false | ||||||
|  |  | ||||||
|  | 	// Start a goroutine to use the iterator | ||||||
|  | 	go func() { | ||||||
|  | 		for msg := range iterSeq { | ||||||
|  | 			if msg == "hello" { | ||||||
|  | 				received = true | ||||||
|  | 				done <- true | ||||||
|  | 				return // Stop iteration | ||||||
|  | 			} | ||||||
|  | 		} | ||||||
|  | 	}() | ||||||
|  |  | ||||||
|  | 	// Give time for the iterator to start | ||||||
|  | 	time.Sleep(100 * time.Millisecond) | ||||||
|  |  | ||||||
|  | 	// Publish a message | ||||||
|  | 	ps.Publish("test-ns", "hello") | ||||||
|  |  | ||||||
|  | 	// Wait for the message to be received or timeout | ||||||
|  | 	select { | ||||||
|  | 	case <-done: | ||||||
|  | 		if !received { | ||||||
|  | 			t.Fatal("Message was received but not 'hello'") | ||||||
|  | 		} | ||||||
|  | 	case <-time.After(time.Second): | ||||||
|  | 		t.Fatal("Timed out waiting for message") | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	subCount := ps.SubscriberCount("test-ns") | ||||||
|  | 	if subCount != 0 { | ||||||
|  | 		t.Fatalf("Expected 0 receivers, got %d", subCount) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestPubSub_Publish(t *testing.T) { | ||||||
|  | 	ps := NewPubSub[string, string](10) | ||||||
|  |  | ||||||
|  | 	// Test publishing to a namespace with no subscribers | ||||||
|  | 	subs, receivers := ps.Publish("empty-ns", "hello") | ||||||
|  | 	if subs != 0 { | ||||||
|  | 		t.Fatalf("Expected 0 subscribers, got %d", subs) | ||||||
|  | 	} | ||||||
|  | 	if receivers != 0 { | ||||||
|  | 		t.Fatalf("Expected 0 receivers, got %d", receivers) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Add a subscriber | ||||||
|  | 	ch, sub := ps.SubscribeByChan("test-ns", 1) | ||||||
|  | 	defer sub.Unsubscribe() | ||||||
|  |  | ||||||
|  | 	// Publish a message | ||||||
|  | 	subs, receivers = ps.Publish("test-ns", "hello") | ||||||
|  | 	if subs != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 subscriber, got %d", subs) | ||||||
|  | 	} | ||||||
|  | 	if receivers != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 receiver, got %d", receivers) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Verify the message was received | ||||||
|  | 	select { | ||||||
|  | 	case msg := <-ch: | ||||||
|  | 		if msg != "hello" { | ||||||
|  | 			t.Fatalf("Expected to receive 'hello', got '%s'", msg) | ||||||
|  | 		} | ||||||
|  | 	case <-time.After(time.Second): | ||||||
|  | 		t.Fatal("Timed out waiting for message") | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Test non-blocking behavior with a full channel | ||||||
|  | 	// First fill the channel | ||||||
|  | 	ps.Publish("test-ns", "fill") | ||||||
|  |  | ||||||
|  | 	// Now publish again - this should not block but skip the receiver | ||||||
|  | 	subs, receivers = ps.Publish("test-ns", "overflow") | ||||||
|  | 	if subs != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 subscriber, got %d", subs) | ||||||
|  | 	} | ||||||
|  | 	// The receiver count might be 0 if the channel is full | ||||||
|  |  | ||||||
|  | 	// Drain the channel | ||||||
|  | 	<-ch | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestPubSub_PublishWithTimeout(t *testing.T) { | ||||||
|  | 	ps := NewPubSub[string, string](10) | ||||||
|  |  | ||||||
|  | 	// Add a subscriber with a channel | ||||||
|  | 	ch, sub := ps.SubscribeByChan("test-ns", 1) | ||||||
|  | 	defer sub.Unsubscribe() | ||||||
|  |  | ||||||
|  | 	// Publish with a timeout | ||||||
|  | 	subs, receivers := ps.PublishWithTimeout("test-ns", "hello", 100*time.Millisecond) | ||||||
|  | 	if subs != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 subscriber, got %d", subs) | ||||||
|  | 	} | ||||||
|  | 	if receivers != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 receiver, got %d", receivers) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Verify the message was received | ||||||
|  | 	select { | ||||||
|  | 	case msg := <-ch: | ||||||
|  | 		if msg != "hello" { | ||||||
|  | 			t.Fatalf("Expected to receive 'hello', got '%s'", msg) | ||||||
|  | 		} | ||||||
|  | 	case <-time.After(time.Second): | ||||||
|  | 		t.Fatal("Timed out waiting for message") | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Fill the channel | ||||||
|  | 	ps.Publish("test-ns", "fill") | ||||||
|  |  | ||||||
|  | 	// Test timeout behavior with a full channel | ||||||
|  | 	start := time.Now() | ||||||
|  | 	subs, receivers = ps.PublishWithTimeout("test-ns", "timeout-test", 50*time.Millisecond) | ||||||
|  | 	elapsed := time.Since(start) | ||||||
|  |  | ||||||
|  | 	if subs != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 subscriber, got %d", subs) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// The receiver count should be 0 if the timeout occurred | ||||||
|  | 	if elapsed < 50*time.Millisecond { | ||||||
|  | 		t.Fatalf("Expected to wait at least 50ms, only waited %v", elapsed) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Drain the channel | ||||||
|  | 	<-ch | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestPubSub_PublishWithContext(t *testing.T) { | ||||||
|  | 	ps := NewPubSub[string, string](10) | ||||||
|  |  | ||||||
|  | 	// Add a subscriber with a channel | ||||||
|  | 	ch, sub := ps.SubscribeByChan("test-ns", 1) | ||||||
|  | 	defer sub.Unsubscribe() | ||||||
|  |  | ||||||
|  | 	// Create a context | ||||||
|  | 	ctx, cancel := context.WithTimeout(context.Background(), 100*time.Millisecond) | ||||||
|  | 	defer cancel() | ||||||
|  |  | ||||||
|  | 	// Publish with context | ||||||
|  | 	subs, receivers, err := ps.PublishWithContext(ctx, "test-ns", "hello") | ||||||
|  | 	if err != nil { | ||||||
|  | 		t.Fatalf("Unexpected error: %v", err) | ||||||
|  | 	} | ||||||
|  | 	if subs != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 subscriber, got %d", subs) | ||||||
|  | 	} | ||||||
|  | 	if receivers != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 receiver, got %d", receivers) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Verify the message was received | ||||||
|  | 	select { | ||||||
|  | 	case msg := <-ch: | ||||||
|  | 		if msg != "hello" { | ||||||
|  | 			t.Fatalf("Expected to receive 'hello', got '%s'", msg) | ||||||
|  | 		} | ||||||
|  | 	case <-time.After(time.Second): | ||||||
|  | 		t.Fatal("Timed out waiting for message") | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Fill the channel | ||||||
|  | 	ps.Publish("test-ns", "fill") | ||||||
|  |  | ||||||
|  | 	// Test context cancellation with a full channel | ||||||
|  | 	ctx, cancel = context.WithCancel(context.Background()) | ||||||
|  |  | ||||||
|  | 	// Cancel the context after a short delay | ||||||
|  | 	go func() { | ||||||
|  | 		time.Sleep(50 * time.Millisecond) | ||||||
|  | 		cancel() | ||||||
|  | 	}() | ||||||
|  |  | ||||||
|  | 	start := time.Now() | ||||||
|  | 	subs, receivers, err = ps.PublishWithContext(ctx, "test-ns", "context-test") | ||||||
|  | 	elapsed := time.Since(start) | ||||||
|  |  | ||||||
|  | 	if subs != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 subscriber, got %d", subs) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Should get a context canceled error | ||||||
|  | 	if err == nil { | ||||||
|  | 		t.Fatal("Expected context canceled error, got nil") | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if elapsed < 50*time.Millisecond { | ||||||
|  | 		t.Fatalf("Expected to wait at least 50ms, only waited %v", elapsed) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Drain the channel | ||||||
|  | 	<-ch | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestPubSub_Unsubscribe(t *testing.T) { | ||||||
|  | 	ps := NewPubSub[string, string](10) | ||||||
|  |  | ||||||
|  | 	// Add a subscriber | ||||||
|  | 	ch, sub := ps.SubscribeByChan("test-ns", 1) | ||||||
|  |  | ||||||
|  | 	// Publish a message | ||||||
|  | 	subs, receivers := ps.Publish("test-ns", "hello") | ||||||
|  | 	if subs != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 subscriber, got %d", subs) | ||||||
|  | 	} | ||||||
|  | 	if receivers != 1 { | ||||||
|  | 		t.Fatalf("Expected 1 receiver, got %d", receivers) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Verify the message was received | ||||||
|  | 	select { | ||||||
|  | 	case msg := <-ch: | ||||||
|  | 		if msg != "hello" { | ||||||
|  | 			t.Fatalf("Expected to receive 'hello', got '%s'", msg) | ||||||
|  | 		} | ||||||
|  | 	case <-time.After(time.Second): | ||||||
|  | 		t.Fatal("Timed out waiting for message") | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Unsubscribe | ||||||
|  | 	sub.Unsubscribe() | ||||||
|  |  | ||||||
|  | 	// Publish again | ||||||
|  | 	subs, receivers = ps.Publish("test-ns", "after-unsub") | ||||||
|  | 	if subs != 0 { | ||||||
|  | 		t.Fatalf("Expected 0 subscribers after unsubscribe, got %d", subs) | ||||||
|  | 	} | ||||||
|  | 	if receivers != 0 { | ||||||
|  | 		t.Fatalf("Expected 0 receivers after unsubscribe, got %d", receivers) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Check that the namespace is removed | ||||||
|  | 	namespaces := ps.Namespaces() | ||||||
|  | 	if len(namespaces) != 0 { | ||||||
|  | 		t.Fatalf("Expected 0 namespaces after unsubscribe, got %d", len(namespaces)) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestPubSub_MultipleSubscribers(t *testing.T) { | ||||||
|  | 	ps := NewPubSub[string, string](10) | ||||||
|  |  | ||||||
|  | 	// Add multiple subscribers | ||||||
|  | 	ch1, sub1 := ps.SubscribeByChan("test-ns", 1) | ||||||
|  | 	defer sub1.Unsubscribe() | ||||||
|  |  | ||||||
|  | 	ch2, sub2 := ps.SubscribeByChan("test-ns", 1) | ||||||
|  | 	defer sub2.Unsubscribe() | ||||||
|  |  | ||||||
|  | 	var received string | ||||||
|  | 	var wg sync.WaitGroup | ||||||
|  | 	wg.Add(1) | ||||||
|  |  | ||||||
|  | 	sub3 := ps.SubscribeByCallback("test-ns", func(msg string) { | ||||||
|  | 		received = msg | ||||||
|  | 		wg.Done() | ||||||
|  | 	}) | ||||||
|  | 	defer sub3.Unsubscribe() | ||||||
|  |  | ||||||
|  | 	// Publish a message | ||||||
|  | 	subs, receivers := ps.Publish("test-ns", "hello") | ||||||
|  | 	if subs != 3 { | ||||||
|  | 		t.Fatalf("Expected 3 subscribers, got %d", subs) | ||||||
|  | 	} | ||||||
|  | 	if receivers != 3 { | ||||||
|  | 		t.Fatalf("Expected 3 receivers, got %d", receivers) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Verify the message was received by all subscribers | ||||||
|  | 	select { | ||||||
|  | 	case msg := <-ch1: | ||||||
|  | 		if msg != "hello" { | ||||||
|  | 			t.Fatalf("Expected ch1 to receive 'hello', got '%s'", msg) | ||||||
|  | 		} | ||||||
|  | 	case <-time.After(time.Second): | ||||||
|  | 		t.Fatal("Timed out waiting for message on ch1") | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	select { | ||||||
|  | 	case msg := <-ch2: | ||||||
|  | 		if msg != "hello" { | ||||||
|  | 			t.Fatalf("Expected ch2 to receive 'hello', got '%s'", msg) | ||||||
|  | 		} | ||||||
|  | 	case <-time.After(time.Second): | ||||||
|  | 		t.Fatal("Timed out waiting for message on ch2") | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// Wait for the callback | ||||||
|  | 	wg.Wait() | ||||||
|  |  | ||||||
|  | 	if received != "hello" { | ||||||
|  | 		t.Fatalf("Expected callback to receive 'hello', got '%s'", received) | ||||||
|  | 	} | ||||||
|  | } | ||||||
							
								
								
									
										144
									
								
								dataext/ringBuffer.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										144
									
								
								dataext/ringBuffer.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,144 @@ | |||||||
|  | package dataext | ||||||
|  |  | ||||||
|  | import "iter" | ||||||
|  |  | ||||||
|  | type RingBuffer[T any] struct { | ||||||
|  | 	items    []T // | ||||||
|  | 	capacity int // max number of items the buffer can hold | ||||||
|  | 	size     int // how many items are in the buffer | ||||||
|  | 	head     int // ptr to next item | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewRingBuffer[T any](capacity int) *RingBuffer[T] { | ||||||
|  | 	return &RingBuffer[T]{ | ||||||
|  | 		items:    make([]T, capacity), | ||||||
|  | 		capacity: capacity, | ||||||
|  | 		size:     0, | ||||||
|  | 		head:     0, | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (rb *RingBuffer[T]) Push(item T) { | ||||||
|  | 	if rb.size < rb.capacity { | ||||||
|  | 		rb.size++ | ||||||
|  | 	} | ||||||
|  | 	rb.items[rb.head] = item | ||||||
|  | 	rb.head = (rb.head + 1) % rb.capacity | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (rb *RingBuffer[T]) PushPop(item T) *T { | ||||||
|  | 	if rb.size < rb.capacity { | ||||||
|  | 		rb.size++ | ||||||
|  | 		rb.items[rb.head] = item | ||||||
|  | 		rb.head = (rb.head + 1) % rb.capacity | ||||||
|  | 		return nil | ||||||
|  | 	} else { | ||||||
|  | 		prev := rb.items[rb.head] | ||||||
|  | 		rb.items[rb.head] = item | ||||||
|  | 		rb.head = (rb.head + 1) % rb.capacity | ||||||
|  | 		return &prev | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (rb *RingBuffer[T]) Peek() (T, bool) { | ||||||
|  | 	if rb.size == 0 { | ||||||
|  | 		return *new(T), false | ||||||
|  | 	} | ||||||
|  | 	return rb.items[(rb.head-1+rb.capacity)%rb.capacity], true | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (rb *RingBuffer[T]) Items() []T { | ||||||
|  | 	if rb.size < rb.capacity { | ||||||
|  | 		return rb.items[:rb.size] | ||||||
|  | 	} | ||||||
|  | 	return append(rb.items[rb.head:], rb.items[:rb.head]...) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (rb *RingBuffer[T]) Size() int { | ||||||
|  | 	return rb.size | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (rb *RingBuffer[T]) Capacity() int { | ||||||
|  | 	return rb.capacity | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (rb *RingBuffer[T]) Clear() { | ||||||
|  | 	rb.size = 0 | ||||||
|  | 	rb.head = 0 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (rb *RingBuffer[T]) IsFull() bool { | ||||||
|  | 	return rb.size == rb.capacity | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (rb *RingBuffer[T]) At(i int) T { | ||||||
|  | 	if i < 0 || i >= rb.size { | ||||||
|  | 		panic("Index out of bounds") | ||||||
|  | 	} | ||||||
|  | 	if rb.size < rb.capacity { | ||||||
|  | 		return rb.items[i] | ||||||
|  | 	} | ||||||
|  | 	return rb.items[(rb.head+i)%rb.capacity] | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (rb *RingBuffer[T]) Get(i int) (T, bool) { | ||||||
|  | 	if i < 0 || i >= rb.size { | ||||||
|  | 		return *new(T), false | ||||||
|  | 	} | ||||||
|  | 	if rb.size < rb.capacity { | ||||||
|  | 		return rb.items[i], true | ||||||
|  | 	} | ||||||
|  | 	return rb.items[(rb.head+i)%rb.capacity], true | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (rb *RingBuffer[T]) Iter() iter.Seq[T] { | ||||||
|  | 	return func(yield func(T) bool) { | ||||||
|  | 		for i := 0; i < rb.size; i++ { | ||||||
|  | 			if !yield(rb.At(i)) { | ||||||
|  | 				return | ||||||
|  | 			} | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (rb *RingBuffer[T]) Iter2() iter.Seq2[int, T] { | ||||||
|  | 	return func(yield func(int, T) bool) { | ||||||
|  | 		for i := 0; i < rb.size; i++ { | ||||||
|  | 			if !yield(i, rb.At(i)) { | ||||||
|  | 				return | ||||||
|  | 			} | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (rb *RingBuffer[T]) Remove(fnEqual func(v T) bool) int { | ||||||
|  | 	// Mike [2024-11-13]: I *really* tried to write an in-place algorithm to remove elements | ||||||
|  | 	//                    But after carful consideration, I left that as an exercise for future readers | ||||||
|  | 	//                    It is, suprisingly, non-trivial, especially because the head-ptr must be weirdly updated | ||||||
|  | 	//                    And out At() method does not work correctly with {head<>0 && size<capacity} | ||||||
|  |  | ||||||
|  | 	dc := 0 | ||||||
|  | 	b := make([]T, rb.capacity) | ||||||
|  | 	bsize := 0 | ||||||
|  |  | ||||||
|  | 	for i := 0; i < rb.size; i++ { | ||||||
|  | 		comp := rb.At(i) | ||||||
|  | 		if fnEqual(comp) { | ||||||
|  | 			dc++ | ||||||
|  | 		} else { | ||||||
|  | 			b[bsize] = comp | ||||||
|  | 			bsize++ | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if dc == 0 { | ||||||
|  | 		return 0 | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	rb.items = b | ||||||
|  | 	rb.size = bsize | ||||||
|  | 	rb.head = bsize % rb.capacity | ||||||
|  |  | ||||||
|  | 	return dc | ||||||
|  |  | ||||||
|  | } | ||||||
							
								
								
									
										447
									
								
								dataext/ringBuffer_test.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										447
									
								
								dataext/ringBuffer_test.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,447 @@ | |||||||
|  | package dataext | ||||||
|  |  | ||||||
|  | import "testing" | ||||||
|  |  | ||||||
|  | func TestRingBufferPushAddsItem(t *testing.T) { | ||||||
|  | 	rb := NewRingBuffer[int](3) | ||||||
|  | 	rb.Push(1) | ||||||
|  | 	if rb.Size() != 1 { | ||||||
|  | 		t.Errorf("Expected size 1, got %d", rb.Size()) | ||||||
|  | 	} | ||||||
|  | 	if item, _ := rb.Peek(); item != 1 { | ||||||
|  | 		t.Errorf("Expected item 1, got %d", item) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestRingBufferPushPopReturnsOldestItem(t *testing.T) { | ||||||
|  | 	rb := NewRingBuffer[int](3) | ||||||
|  | 	rb.Push(1) | ||||||
|  | 	rb.Push(2) | ||||||
|  | 	rb.Push(3) | ||||||
|  | 	if item := rb.PushPop(4); item == nil || *item != 1 { | ||||||
|  | 		t.Errorf("Expected item 1, got %v", item) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestRingBufferPeekReturnsLastPushedItem(t *testing.T) { | ||||||
|  | 	rb := NewRingBuffer[int](3) | ||||||
|  | 	rb.Push(1) | ||||||
|  | 	rb.Push(2) | ||||||
|  | 	if item, _ := rb.Peek(); item != 2 { | ||||||
|  | 		t.Errorf("Expected item 2, got %d", item) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestRingBufferOverflow1(t *testing.T) { | ||||||
|  | 	rb := NewRingBuffer[int](5) | ||||||
|  | 	rb.Push(1) // overriden | ||||||
|  | 	rb.Push(2) // overriden | ||||||
|  | 	rb.Push(3) | ||||||
|  | 	rb.Push(9) | ||||||
|  | 	rb.Push(4) | ||||||
|  | 	rb.Push(5) | ||||||
|  | 	rb.Push(7) | ||||||
|  | 	if rb.Size() != 5 { | ||||||
|  | 		t.Errorf("Expected size 4, got %d", rb.Size()) | ||||||
|  | 	} | ||||||
|  | 	expected := []int{3, 9, 4, 5, 7} | ||||||
|  | 	items := rb.Items() | ||||||
|  | 	for i, item := range items { | ||||||
|  | 		if item != expected[i] { | ||||||
|  | 			t.Errorf("Expected item %d, got %d", expected[i], item) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestRingBufferItemsReturnsAllItems(t *testing.T) { | ||||||
|  | 	rb := NewRingBuffer[int](3) | ||||||
|  | 	rb.Push(1) | ||||||
|  | 	rb.Push(2) | ||||||
|  | 	rb.Push(3) | ||||||
|  | 	items := rb.Items() | ||||||
|  | 	expected := []int{1, 2, 3} | ||||||
|  | 	for i, item := range items { | ||||||
|  | 		if item != expected[i] { | ||||||
|  | 			t.Errorf("Expected item %d, got %d", expected[i], item) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestRingBufferClearEmptiesBuffer(t *testing.T) { | ||||||
|  | 	rb := NewRingBuffer[int](3) | ||||||
|  | 	rb.Push(1) | ||||||
|  | 	rb.Clear() | ||||||
|  | 	if rb.Size() != 0 { | ||||||
|  | 		t.Errorf("Expected size 0, got %d", rb.Size()) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestRingBufferIsFullReturnsTrueWhenFull(t *testing.T) { | ||||||
|  | 	rb := NewRingBuffer[int](3) | ||||||
|  | 	rb.Push(1) | ||||||
|  | 	rb.Push(2) | ||||||
|  | 	rb.Push(3) | ||||||
|  | 	if !rb.IsFull() { | ||||||
|  | 		t.Errorf("Expected buffer to be full") | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestRingBufferAtReturnsCorrectItem(t *testing.T) { | ||||||
|  | 	rb := NewRingBuffer[int](3) | ||||||
|  | 	rb.Push(1) | ||||||
|  | 	rb.Push(2) | ||||||
|  | 	rb.Push(3) | ||||||
|  | 	if item := rb.At(1); item != 2 { | ||||||
|  | 		t.Errorf("Expected item 2, got %d", item) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestRingBufferGetReturnsCorrectItem(t *testing.T) { | ||||||
|  | 	rb := NewRingBuffer[int](3) | ||||||
|  | 	rb.Push(1) | ||||||
|  | 	rb.Push(2) | ||||||
|  | 	rb.Push(3) | ||||||
|  | 	if item, ok := rb.Get(1); !ok || item != 2 { | ||||||
|  | 		t.Errorf("Expected item 2, got %d", item) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestRingBufferRemoveDeletesMatchingItems(t *testing.T) { | ||||||
|  | 	rb := NewRingBuffer[int](5) | ||||||
|  | 	rb.Push(1) | ||||||
|  | 	rb.Push(2) | ||||||
|  | 	rb.Push(3) | ||||||
|  | 	rb.Push(2) | ||||||
|  | 	rb.Push(4) | ||||||
|  | 	removed := rb.Remove(func(v int) bool { return v == 2 }) | ||||||
|  | 	if removed != 2 { | ||||||
|  | 		t.Errorf("Expected 2 items removed, got %d", removed) | ||||||
|  | 	} | ||||||
|  | 	if rb.Size() != 3 { | ||||||
|  | 		t.Errorf("Expected size 3, got %d", rb.Size()) | ||||||
|  | 	} | ||||||
|  | 	expected := []int{1, 3, 4} | ||||||
|  | 	items := rb.Items() | ||||||
|  | 	for i, item := range items { | ||||||
|  | 		if item != expected[i] { | ||||||
|  | 			t.Errorf("Expected item %d, got %d", expected[i], item) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestRingBufferRemoveDeletesMatchingItems2(t *testing.T) { | ||||||
|  | 	rb := NewRingBuffer[int](5) | ||||||
|  | 	rb.Push(1) | ||||||
|  | 	rb.Push(2) | ||||||
|  | 	rb.Push(3) | ||||||
|  | 	rb.Push(2) | ||||||
|  | 	rb.Push(4) | ||||||
|  | 	removed := rb.Remove(func(v int) bool { return v == 3 }) | ||||||
|  | 	if removed != 1 { | ||||||
|  | 		t.Errorf("Expected 2 items removed, got %d", removed) | ||||||
|  | 	} | ||||||
|  | 	if rb.Size() != 4 { | ||||||
|  | 		t.Errorf("Expected size 3, got %d", rb.Size()) | ||||||
|  | 	} | ||||||
|  | 	expected := []int{1, 2, 2, 4} | ||||||
|  | 	items := rb.Items() | ||||||
|  | 	for i, item := range items { | ||||||
|  | 		if item != expected[i] { | ||||||
|  | 			t.Errorf("Expected item %d, got %d", expected[i], item) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestRingBufferRemoveDeletesMatchingItems3(t *testing.T) { | ||||||
|  | 	rb := NewRingBuffer[int](5) | ||||||
|  | 	rb.Push(1) | ||||||
|  | 	rb.Push(2) | ||||||
|  | 	rb.Push(3) | ||||||
|  | 	rb.Push(9) | ||||||
|  | 	rb.Push(4) | ||||||
|  | 	removed := rb.Remove(func(v int) bool { return v == 3 }) | ||||||
|  | 	if removed != 1 { | ||||||
|  | 		t.Errorf("Expected 2 items removed, got %d", removed) | ||||||
|  | 	} | ||||||
|  | 	if rb.Size() != 4 { | ||||||
|  | 		t.Errorf("Expected size 3, got %d", rb.Size()) | ||||||
|  | 	} | ||||||
|  | 	expected := []int{1, 2, 9, 4} | ||||||
|  | 	items := rb.Items() | ||||||
|  | 	for i, item := range items { | ||||||
|  | 		if item != expected[i] { | ||||||
|  | 			t.Errorf("Expected item %d, got %d", expected[i], item) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestRingBufferRemoveDeletesMatchingItems4(t *testing.T) { | ||||||
|  | 	rb := NewRingBuffer[int](5) | ||||||
|  | 	rb.Push(1) // overriden | ||||||
|  | 	rb.Push(2) // overriden | ||||||
|  | 	rb.Push(3) | ||||||
|  | 	rb.Push(9) | ||||||
|  | 	rb.Push(4) | ||||||
|  | 	rb.Push(5) | ||||||
|  | 	rb.Push(7) | ||||||
|  | 	removed := rb.Remove(func(v int) bool { return v == 7 }) | ||||||
|  | 	if removed != 1 { | ||||||
|  | 		t.Errorf("Expected 1 items removed, got %d", removed) | ||||||
|  | 	} | ||||||
|  | 	if rb.Size() != 4 { | ||||||
|  | 		t.Errorf("Expected size 4, got %d", rb.Size()) | ||||||
|  | 	} | ||||||
|  | 	expected := []int{3, 9, 4, 5} | ||||||
|  | 	items := rb.Items() | ||||||
|  | 	for i, item := range items { | ||||||
|  | 		if item != expected[i] { | ||||||
|  | 			t.Errorf("Expected item %d, got %d", expected[i], item) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestRingBufferRemoveDeletesMatchingItems5(t *testing.T) { | ||||||
|  | 	rb := NewRingBuffer[int](5) | ||||||
|  | 	rb.Push(1) // overriden | ||||||
|  | 	rb.Push(2) // overriden | ||||||
|  | 	rb.Push(3) | ||||||
|  | 	rb.Push(9) | ||||||
|  | 	rb.Push(4) | ||||||
|  | 	rb.Push(5) | ||||||
|  | 	rb.Push(7) | ||||||
|  | 	removed := rb.Remove(func(v int) bool { return v == 3 }) | ||||||
|  | 	if removed != 1 { | ||||||
|  | 		t.Errorf("Expected 1 items removed, got %d", removed) | ||||||
|  | 	} | ||||||
|  | 	if rb.Size() != 4 { | ||||||
|  | 		t.Errorf("Expected size 4, got %d", rb.Size()) | ||||||
|  | 	} | ||||||
|  | 	expected := []int{9, 4, 5, 7} | ||||||
|  | 	items := rb.Items() | ||||||
|  | 	for i, item := range items { | ||||||
|  | 		if item != expected[i] { | ||||||
|  | 			t.Errorf("Expected item %d, got %d", expected[i], item) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestRingBufferRemoveDeletesMatchingItems6(t *testing.T) { | ||||||
|  | 	rb := NewRingBuffer[int](5) | ||||||
|  | 	rb.Push(1) // overriden | ||||||
|  | 	rb.Push(2) // overriden | ||||||
|  | 	rb.Push(3) | ||||||
|  | 	rb.Push(9) | ||||||
|  | 	rb.Push(4) | ||||||
|  | 	rb.Push(5) | ||||||
|  | 	rb.Push(7) | ||||||
|  | 	removed := rb.Remove(func(v int) bool { return v == 1 }) | ||||||
|  | 	if removed != 0 { | ||||||
|  | 		t.Errorf("Expected 0 items removed, got %d", removed) | ||||||
|  | 	} | ||||||
|  | 	if rb.Size() != 5 { | ||||||
|  | 		t.Errorf("Expected size 5, got %d", rb.Size()) | ||||||
|  | 	} | ||||||
|  | 	expected := []int{3, 9, 4, 5, 7} | ||||||
|  | 	items := rb.Items() | ||||||
|  | 	for i, item := range items { | ||||||
|  | 		if item != expected[i] { | ||||||
|  | 			t.Errorf("Expected item %d, got %d", expected[i], item) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | 	if !rb.IsFull() { | ||||||
|  | 		t.Errorf("Expected buffer to not be full") | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestRingBufferRemoveDeletesMatchingItems7(t *testing.T) { | ||||||
|  | 	rb := NewRingBuffer[int](5) | ||||||
|  | 	rb.Push(1) // overriden | ||||||
|  | 	rb.Push(2) // overriden | ||||||
|  | 	rb.Push(3) | ||||||
|  | 	rb.Push(9) | ||||||
|  | 	rb.Push(4) | ||||||
|  | 	rb.Push(5) | ||||||
|  | 	rb.Push(7) | ||||||
|  | 	removed := rb.Remove(func(v int) bool { return v == 9 }) | ||||||
|  | 	if removed != 1 { | ||||||
|  | 		t.Errorf("Expected 1 items removed, got %d", removed) | ||||||
|  | 	} | ||||||
|  | 	if rb.Size() != 4 { | ||||||
|  | 		t.Errorf("Expected size 4, got %d", rb.Size()) | ||||||
|  | 	} | ||||||
|  | 	expected := []int{3, 4, 5, 7} | ||||||
|  | 	items := rb.Items() | ||||||
|  | 	for i, item := range items { | ||||||
|  | 		if item != expected[i] { | ||||||
|  | 			t.Errorf("Expected item %d, got %d", expected[i], item) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | 	if rb.IsFull() { | ||||||
|  | 		t.Errorf("Expected buffer to not be full") | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestRingBufferAddItemsToFullRingBuffer(t *testing.T) { | ||||||
|  | 	rb := NewRingBuffer[int](3) | ||||||
|  | 	rb.Push(1) | ||||||
|  | 	rb.Push(2) | ||||||
|  | 	rb.Push(3) | ||||||
|  | 	rb.Push(4) | ||||||
|  | 	if rb.Size() != 3 { | ||||||
|  | 		t.Errorf("Expected size 3, got %d", rb.Size()) | ||||||
|  | 	} | ||||||
|  | 	expected := []int{2, 3, 4} | ||||||
|  | 	items := rb.Items() | ||||||
|  | 	for i, item := range items { | ||||||
|  | 		if item != expected[i] { | ||||||
|  | 			t.Errorf("Expected item %d, got %d", expected[i], item) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestRingBufferAddItemsToNonFullRingBuffer(t *testing.T) { | ||||||
|  | 	rb := NewRingBuffer[int](3) | ||||||
|  | 	rb.Push(1) | ||||||
|  | 	rb.Push(2) | ||||||
|  | 	if rb.Size() != 2 { | ||||||
|  | 		t.Errorf("Expected size 2, got %d", rb.Size()) | ||||||
|  | 	} | ||||||
|  | 	expected := []int{1, 2} | ||||||
|  | 	items := rb.Items() | ||||||
|  | 	for i, item := range items { | ||||||
|  | 		if item != expected[i] { | ||||||
|  | 			t.Errorf("Expected item %d, got %d", expected[i], item) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestRingBufferRemoveItemsFromNonFullRingBuffer(t *testing.T) { | ||||||
|  | 	rb := NewRingBuffer[int](3) | ||||||
|  | 	rb.Push(1) | ||||||
|  | 	rb.Push(2) | ||||||
|  | 	removed := rb.Remove(func(v int) bool { return v == 1 }) | ||||||
|  | 	if removed != 1 { | ||||||
|  | 		t.Errorf("Expected 1 item removed, got %d", removed) | ||||||
|  | 	} | ||||||
|  | 	if rb.Size() != 1 { | ||||||
|  | 		t.Errorf("Expected size 1, got %d", rb.Size()) | ||||||
|  | 	} | ||||||
|  | 	expected := []int{2} | ||||||
|  | 	items := rb.Items() | ||||||
|  | 	for i, item := range items { | ||||||
|  | 		if item != expected[i] { | ||||||
|  | 			t.Errorf("Expected item %d, got %d", expected[i], item) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestRingBufferRemoveItemsFromFullRingBuffer(t *testing.T) { | ||||||
|  | 	rb := NewRingBuffer[int](3) | ||||||
|  | 	rb.Push(1) | ||||||
|  | 	rb.Push(2) | ||||||
|  | 	rb.Push(3) | ||||||
|  | 	removed := rb.Remove(func(v int) bool { return v == 2 }) | ||||||
|  | 	if removed != 1 { | ||||||
|  | 		t.Errorf("Expected 1 item removed, got %d", removed) | ||||||
|  | 	} | ||||||
|  | 	if rb.Size() != 2 { | ||||||
|  | 		t.Errorf("Expected size 2, got %d", rb.Size()) | ||||||
|  | 	} | ||||||
|  | 	expected := []int{1, 3} | ||||||
|  | 	items := rb.Items() | ||||||
|  | 	for i, item := range items { | ||||||
|  | 		if item != expected[i] { | ||||||
|  | 			t.Errorf("Expected item %d, got %d", expected[i], item) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestRingBufferRemoveMultipleItemsFromRingBuffer(t *testing.T) { | ||||||
|  | 	rb := NewRingBuffer[int](5) | ||||||
|  | 	rb.Push(1) | ||||||
|  | 	rb.Push(2) | ||||||
|  | 	rb.Push(3) | ||||||
|  | 	rb.Push(2) | ||||||
|  | 	rb.Push(4) | ||||||
|  | 	removed := rb.Remove(func(v int) bool { return v == 2 }) | ||||||
|  | 	if removed != 2 { | ||||||
|  | 		t.Errorf("Expected 2 items removed, got %d", removed) | ||||||
|  | 	} | ||||||
|  | 	if rb.Size() != 3 { | ||||||
|  | 		t.Errorf("Expected size 3, got %d", rb.Size()) | ||||||
|  | 	} | ||||||
|  | 	expected := []int{1, 3, 4} | ||||||
|  | 	items := rb.Items() | ||||||
|  | 	for i, item := range items { | ||||||
|  | 		if item != expected[i] { | ||||||
|  | 			t.Errorf("Expected item %d, got %d", expected[i], item) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestRingBufferRemoveAllItemsFromRingBuffer(t *testing.T) { | ||||||
|  | 	rb := NewRingBuffer[int](3) | ||||||
|  | 	rb.Push(1) | ||||||
|  | 	rb.Push(2) | ||||||
|  | 	rb.Push(3) | ||||||
|  | 	removed := rb.Remove(func(v int) bool { return true }) | ||||||
|  | 	if removed != 3 { | ||||||
|  | 		t.Errorf("Expected 3 items removed, got %d", removed) | ||||||
|  | 	} | ||||||
|  | 	if rb.Size() != 0 { | ||||||
|  | 		t.Errorf("Expected size 0, got %d", rb.Size()) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestRingBufferRemoveNoItemsFromRingBuffer(t *testing.T) { | ||||||
|  | 	rb := NewRingBuffer[int](3) | ||||||
|  | 	rb.Push(1) | ||||||
|  | 	rb.Push(2) | ||||||
|  | 	rb.Push(3) | ||||||
|  | 	removed := rb.Remove(func(v int) bool { return false }) | ||||||
|  | 	if removed != 0 { | ||||||
|  | 		t.Errorf("Expected 0 items removed, got %d", removed) | ||||||
|  | 	} | ||||||
|  | 	if rb.Size() != 3 { | ||||||
|  | 		t.Errorf("Expected size 3, got %d", rb.Size()) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestRingBufferIteratesOverAllItems(t *testing.T) { | ||||||
|  | 	rb := NewRingBuffer[int](3) | ||||||
|  | 	rb.Push(1) | ||||||
|  | 	rb.Push(2) | ||||||
|  | 	rb.Push(3) | ||||||
|  | 	expected := []int{1, 2, 3} | ||||||
|  | 	i := 0 | ||||||
|  | 	for item := range rb.Iter() { | ||||||
|  | 		if item != expected[i] { | ||||||
|  | 			t.Errorf("Expected item %d, got %d", expected[i], item) | ||||||
|  | 		} | ||||||
|  | 		i++ | ||||||
|  | 	} | ||||||
|  | 	if i != len(expected) { | ||||||
|  | 		t.Errorf("Expected to iterate over %d items, but iterated over %d", len(expected), i) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestRingBufferIter2IteratesOverAllItemsWithIndices(t *testing.T) { | ||||||
|  | 	rb := NewRingBuffer[int](3) | ||||||
|  | 	rb.Push(1) | ||||||
|  | 	rb.Push(2) | ||||||
|  | 	rb.Push(3) | ||||||
|  | 	expected := []int{1, 2, 3} | ||||||
|  | 	i := 0 | ||||||
|  | 	for index, item := range rb.Iter2() { | ||||||
|  | 		if index != i { | ||||||
|  | 			t.Errorf("Expected index %d, got %d", i, index) | ||||||
|  | 		} | ||||||
|  | 		if item != expected[i] { | ||||||
|  | 			t.Errorf("Expected item %d, got %d", expected[i], item) | ||||||
|  | 		} | ||||||
|  | 		i++ | ||||||
|  | 	} | ||||||
|  | 	if i != len(expected) { | ||||||
|  | 		t.Errorf("Expected to iterate over %d items, but iterated over %d", len(expected), i) | ||||||
|  | 	} | ||||||
|  | } | ||||||
| @@ -2,7 +2,7 @@ package dataext | |||||||
|  |  | ||||||
| import ( | import ( | ||||||
| 	"errors" | 	"errors" | ||||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/langext" | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
| 	"sync" | 	"sync" | ||||||
| ) | ) | ||||||
|  |  | ||||||
|   | |||||||
| @@ -6,7 +6,7 @@ import ( | |||||||
| 	"encoding/binary" | 	"encoding/binary" | ||||||
| 	"errors" | 	"errors" | ||||||
| 	"fmt" | 	"fmt" | ||||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/langext" | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
| 	"hash" | 	"hash" | ||||||
| 	"io" | 	"io" | ||||||
| 	"reflect" | 	"reflect" | ||||||
|   | |||||||
| @@ -1,8 +1,8 @@ | |||||||
| package dataext | package dataext | ||||||
|  |  | ||||||
| import ( | import ( | ||||||
| 	"encoding/hex" | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/langext" | 	"git.blackforestbytes.com/BlackForestBytes/goext/tst" | ||||||
| 	"testing" | 	"testing" | ||||||
| ) | ) | ||||||
|  |  | ||||||
| @@ -18,14 +18,14 @@ func noErrStructHash(t *testing.T, dat any, opt ...StructHashOptions) []byte { | |||||||
|  |  | ||||||
| func TestStructHashSimple(t *testing.T) { | func TestStructHashSimple(t *testing.T) { | ||||||
|  |  | ||||||
| 	assertEqual(t, "209bf774af36cc3a045c152d9f1269ef3684ad819c1359ee73ff0283a308fefa", noErrStructHash(t, "Hello")) | 	tst.AssertHexEqual(t, "209bf774af36cc3a045c152d9f1269ef3684ad819c1359ee73ff0283a308fefa", noErrStructHash(t, "Hello")) | ||||||
| 	assertEqual(t, "c32f3626b981ae2997db656f3acad3f1dc9d30ef6b6d14296c023e391b25f71a", noErrStructHash(t, 0)) | 	tst.AssertHexEqual(t, "c32f3626b981ae2997db656f3acad3f1dc9d30ef6b6d14296c023e391b25f71a", noErrStructHash(t, 0)) | ||||||
| 	assertEqual(t, "01b781b03e9586b257d387057dfc70d9f06051e7d3c1e709a57e13cc8daf3e35", noErrStructHash(t, []byte{})) | 	tst.AssertHexEqual(t, "01b781b03e9586b257d387057dfc70d9f06051e7d3c1e709a57e13cc8daf3e35", noErrStructHash(t, []byte{})) | ||||||
| 	assertEqual(t, "93e1dcd45c732fe0079b0fb3204c7c803f0921835f6bfee2e6ff263e73eed53c", noErrStructHash(t, []int{})) | 	tst.AssertHexEqual(t, "93e1dcd45c732fe0079b0fb3204c7c803f0921835f6bfee2e6ff263e73eed53c", noErrStructHash(t, []int{})) | ||||||
| 	assertEqual(t, "54f637a376aad55b3160d98ebbcae8099b70d91b9400df23fb3709855d59800a", noErrStructHash(t, []int{1, 2, 3})) | 	tst.AssertHexEqual(t, "54f637a376aad55b3160d98ebbcae8099b70d91b9400df23fb3709855d59800a", noErrStructHash(t, []int{1, 2, 3})) | ||||||
| 	assertEqual(t, "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", noErrStructHash(t, nil)) | 	tst.AssertHexEqual(t, "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", noErrStructHash(t, nil)) | ||||||
| 	assertEqual(t, "349a7db91aa78fd30bbaa7c7f9c7bfb2fcfe72869b4861162a96713a852f60d3", noErrStructHash(t, []any{1, "", nil})) | 	tst.AssertHexEqual(t, "349a7db91aa78fd30bbaa7c7f9c7bfb2fcfe72869b4861162a96713a852f60d3", noErrStructHash(t, []any{1, "", nil})) | ||||||
| 	assertEqual(t, "ca51aab87808bf0062a4a024de6aac0c2bad54275cc857a4944569f89fd245ad", noErrStructHash(t, struct{}{})) | 	tst.AssertHexEqual(t, "ca51aab87808bf0062a4a024de6aac0c2bad54275cc857a4944569f89fd245ad", noErrStructHash(t, struct{}{})) | ||||||
|  |  | ||||||
| } | } | ||||||
|  |  | ||||||
| @@ -37,13 +37,13 @@ func TestStructHashSimpleStruct(t *testing.T) { | |||||||
| 		F3 *int | 		F3 *int | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	assertEqual(t, "a90bff751c70c738bb5cfc9b108e783fa9c19c0bc9273458e0aaee6e74aa1b92", noErrStructHash(t, t0{ | 	tst.AssertHexEqual(t, "a90bff751c70c738bb5cfc9b108e783fa9c19c0bc9273458e0aaee6e74aa1b92", noErrStructHash(t, t0{ | ||||||
| 		F1: 10, | 		F1: 10, | ||||||
| 		F2: []string{"1", "2", "3"}, | 		F2: []string{"1", "2", "3"}, | ||||||
| 		F3: nil, | 		F3: nil, | ||||||
| 	})) | 	})) | ||||||
|  |  | ||||||
| 	assertEqual(t, "5d09090dc34ac59dd645f197a255f653387723de3afa1b614721ea5a081c675f", noErrStructHash(t, t0{ | 	tst.AssertHexEqual(t, "5d09090dc34ac59dd645f197a255f653387723de3afa1b614721ea5a081c675f", noErrStructHash(t, t0{ | ||||||
| 		F1: 10, | 		F1: 10, | ||||||
| 		F2: []string{"1", "2", "3"}, | 		F2: []string{"1", "2", "3"}, | ||||||
| 		F3: langext.Ptr(99), | 		F3: langext.Ptr(99), | ||||||
| @@ -64,7 +64,7 @@ func TestStructHashLayeredStruct(t *testing.T) { | |||||||
| 		SV3 t1_1 | 		SV3 t1_1 | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	assertEqual(t, "fd4ca071fb40a288fee4b7a3dfdaab577b30cb8f80f81ec511e7afd72dc3b469", noErrStructHash(t, t1_2{ | 	tst.AssertHexEqual(t, "fd4ca071fb40a288fee4b7a3dfdaab577b30cb8f80f81ec511e7afd72dc3b469", noErrStructHash(t, t1_2{ | ||||||
| 		SV1: nil, | 		SV1: nil, | ||||||
| 		SV2: nil, | 		SV2: nil, | ||||||
| 		SV3: t1_1{ | 		SV3: t1_1{ | ||||||
| @@ -73,7 +73,7 @@ func TestStructHashLayeredStruct(t *testing.T) { | |||||||
| 			F15: false, | 			F15: false, | ||||||
| 		}, | 		}, | ||||||
| 	})) | 	})) | ||||||
| 	assertEqual(t, "3fbf7c67d8121deda075cc86319a4e32d71744feb2cebf89b43bc682f072a029", noErrStructHash(t, t1_2{ | 	tst.AssertHexEqual(t, "3fbf7c67d8121deda075cc86319a4e32d71744feb2cebf89b43bc682f072a029", noErrStructHash(t, t1_2{ | ||||||
| 		SV1: nil, | 		SV1: nil, | ||||||
| 		SV2: &t1_1{}, | 		SV2: &t1_1{}, | ||||||
| 		SV3: t1_1{ | 		SV3: t1_1{ | ||||||
| @@ -82,7 +82,7 @@ func TestStructHashLayeredStruct(t *testing.T) { | |||||||
| 			F15: true, | 			F15: true, | ||||||
| 		}, | 		}, | ||||||
| 	})) | 	})) | ||||||
| 	assertEqual(t, "b1791ccd1b346c3ede5bbffda85555adcd8216b93ffca23f14fe175ec47c5104", noErrStructHash(t, t1_2{ | 	tst.AssertHexEqual(t, "b1791ccd1b346c3ede5bbffda85555adcd8216b93ffca23f14fe175ec47c5104", noErrStructHash(t, t1_2{ | ||||||
| 		SV1: &t1_1{}, | 		SV1: &t1_1{}, | ||||||
| 		SV2: &t1_1{}, | 		SV2: &t1_1{}, | ||||||
| 		SV3: t1_1{ | 		SV3: t1_1{ | ||||||
| @@ -101,7 +101,7 @@ func TestStructHashMap(t *testing.T) { | |||||||
| 		F2 map[string]int | 		F2 map[string]int | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	assertEqual(t, "d50c53ad1fafb448c33fddd5aca01a86a2edf669ce2ecab07ba6fe877951d824", noErrStructHash(t, t0{ | 	tst.AssertHexEqual(t, "d50c53ad1fafb448c33fddd5aca01a86a2edf669ce2ecab07ba6fe877951d824", noErrStructHash(t, t0{ | ||||||
| 		F1: 10, | 		F1: 10, | ||||||
| 		F2: map[string]int{ | 		F2: map[string]int{ | ||||||
| 			"x": 1, | 			"x": 1, | ||||||
| @@ -110,7 +110,7 @@ func TestStructHashMap(t *testing.T) { | |||||||
| 		}, | 		}, | ||||||
| 	})) | 	})) | ||||||
|  |  | ||||||
| 	assertEqual(t, "d50c53ad1fafb448c33fddd5aca01a86a2edf669ce2ecab07ba6fe877951d824", noErrStructHash(t, t0{ | 	tst.AssertHexEqual(t, "d50c53ad1fafb448c33fddd5aca01a86a2edf669ce2ecab07ba6fe877951d824", noErrStructHash(t, t0{ | ||||||
| 		F1: 10, | 		F1: 10, | ||||||
| 		F2: map[string]int{ | 		F2: map[string]int{ | ||||||
| 			"a": 99, | 			"a": 99, | ||||||
| @@ -128,16 +128,9 @@ func TestStructHashMap(t *testing.T) { | |||||||
| 	m3["x"] = 1 | 	m3["x"] = 1 | ||||||
| 	m3["a"] = 2 | 	m3["a"] = 2 | ||||||
|  |  | ||||||
| 	assertEqual(t, "d50c53ad1fafb448c33fddd5aca01a86a2edf669ce2ecab07ba6fe877951d824", noErrStructHash(t, t0{ | 	tst.AssertHexEqual(t, "d50c53ad1fafb448c33fddd5aca01a86a2edf669ce2ecab07ba6fe877951d824", noErrStructHash(t, t0{ | ||||||
| 		F1: 10, | 		F1: 10, | ||||||
| 		F2: m3, | 		F2: m3, | ||||||
| 	})) | 	})) | ||||||
|  |  | ||||||
| } | } | ||||||
|  |  | ||||||
| func assertEqual(t *testing.T, expected string, actual []byte) { |  | ||||||
| 	actualStr := hex.EncodeToString(actual) |  | ||||||
| 	if actualStr != expected { |  | ||||||
| 		t.Errorf("values differ: Actual: '%v', Expected: '%v'", actualStr, expected) |  | ||||||
| 	} |  | ||||||
| } |  | ||||||
|   | |||||||
							
								
								
									
										256
									
								
								dataext/syncMap.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										256
									
								
								dataext/syncMap.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,256 @@ | |||||||
|  | package dataext | ||||||
|  |  | ||||||
|  | import "sync" | ||||||
|  |  | ||||||
|  | // SyncMap is a thread-safe map implementation for generic key-value pairs. | ||||||
|  | // All functions aresafe to be called in parallel. | ||||||
|  | type SyncMap[TKey comparable, TData any] struct { | ||||||
|  | 	data map[TKey]TData | ||||||
|  | 	lock sync.Mutex | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewSyncMap[TKey comparable, TData any]() *SyncMap[TKey, TData] { | ||||||
|  | 	return &SyncMap[TKey, TData]{data: make(map[TKey]TData), lock: sync.Mutex{}} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // Set sets the value for the provided key | ||||||
|  | func (s *SyncMap[TKey, TData]) Set(key TKey, data TData) { | ||||||
|  | 	s.lock.Lock() | ||||||
|  | 	defer s.lock.Unlock() | ||||||
|  |  | ||||||
|  | 	if s.data == nil { | ||||||
|  | 		s.data = make(map[TKey]TData) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	s.data[key] = data | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // SetIfNotContains sets the value for the provided key if it does not already exist | ||||||
|  | func (s *SyncMap[TKey, TData]) SetIfNotContains(key TKey, data TData) bool { | ||||||
|  | 	s.lock.Lock() | ||||||
|  | 	defer s.lock.Unlock() | ||||||
|  |  | ||||||
|  | 	if s.data == nil { | ||||||
|  | 		s.data = make(map[TKey]TData) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if _, existsInPreState := s.data[key]; existsInPreState { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	s.data[key] = data | ||||||
|  |  | ||||||
|  | 	return true | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // SetIfNotContainsFunc sets the value for the provided key using the provided function | ||||||
|  | func (s *SyncMap[TKey, TData]) SetIfNotContainsFunc(key TKey, data func() TData) bool { | ||||||
|  | 	s.lock.Lock() | ||||||
|  | 	defer s.lock.Unlock() | ||||||
|  |  | ||||||
|  | 	if s.data == nil { | ||||||
|  | 		s.data = make(map[TKey]TData) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if _, existsInPreState := s.data[key]; existsInPreState { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	s.data[key] = data() | ||||||
|  |  | ||||||
|  | 	return true | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // Get retrieves the value for the provided key | ||||||
|  | func (s *SyncMap[TKey, TData]) Get(key TKey) (TData, bool) { | ||||||
|  | 	s.lock.Lock() | ||||||
|  | 	defer s.lock.Unlock() | ||||||
|  |  | ||||||
|  | 	if s.data == nil { | ||||||
|  | 		s.data = make(map[TKey]TData) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if v, ok := s.data[key]; ok { | ||||||
|  | 		return v, true | ||||||
|  | 	} else { | ||||||
|  | 		return *new(TData), false | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // GetAndSetIfNotContains returns the existing value if the key exists. | ||||||
|  | // Otherwise, it sets the provided value and returns it. | ||||||
|  | func (s *SyncMap[TKey, TData]) GetAndSetIfNotContains(key TKey, data TData) TData { | ||||||
|  | 	s.lock.Lock() | ||||||
|  | 	defer s.lock.Unlock() | ||||||
|  |  | ||||||
|  | 	if s.data == nil { | ||||||
|  | 		s.data = make(map[TKey]TData) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if v, ok := s.data[key]; ok { | ||||||
|  | 		return v | ||||||
|  | 	} else { | ||||||
|  | 		s.data[key] = data | ||||||
|  | 		return data | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // GetAndSetIfNotContainsFunc returns the existing value if the key exists. | ||||||
|  | // Otherwise, it calls the provided function to generate the value, sets it, and returns it. | ||||||
|  | func (s *SyncMap[TKey, TData]) GetAndSetIfNotContainsFunc(key TKey, data func() TData) TData { | ||||||
|  | 	s.lock.Lock() | ||||||
|  | 	defer s.lock.Unlock() | ||||||
|  |  | ||||||
|  | 	if s.data == nil { | ||||||
|  | 		s.data = make(map[TKey]TData) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if v, ok := s.data[key]; ok { | ||||||
|  | 		return v | ||||||
|  | 	} else { | ||||||
|  | 		dataObj := data() | ||||||
|  | 		s.data[key] = dataObj | ||||||
|  | 		return dataObj | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // Delete removes the entry with the provided key and returns true if the key existed before. | ||||||
|  | func (s *SyncMap[TKey, TData]) Delete(key TKey) bool { | ||||||
|  | 	s.lock.Lock() | ||||||
|  | 	defer s.lock.Unlock() | ||||||
|  |  | ||||||
|  | 	if s.data == nil { | ||||||
|  | 		s.data = make(map[TKey]TData) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	_, ok := s.data[key] | ||||||
|  |  | ||||||
|  | 	delete(s.data, key) | ||||||
|  |  | ||||||
|  | 	return ok | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // DeleteIf deletes all entries that match the provided function and returns the number of removed entries. | ||||||
|  | func (s *SyncMap[TKey, TData]) DeleteIf(fn func(key TKey, data TData) bool) int { | ||||||
|  | 	s.lock.Lock() | ||||||
|  | 	defer s.lock.Unlock() | ||||||
|  |  | ||||||
|  | 	if s.data == nil { | ||||||
|  | 		s.data = make(map[TKey]TData) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	rm := 0 | ||||||
|  | 	for k, v := range s.data { | ||||||
|  | 		if fn(k, v) { | ||||||
|  | 			delete(s.data, k) | ||||||
|  | 			rm++ | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return rm | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // UpdateIfExists updates the value if the key exists, otherwise it does nothing. | ||||||
|  | func (s *SyncMap[TKey, TData]) UpdateIfExists(key TKey, fn func(data TData) TData) bool { | ||||||
|  | 	s.lock.Lock() | ||||||
|  | 	defer s.lock.Unlock() | ||||||
|  |  | ||||||
|  | 	if s.data == nil { | ||||||
|  | 		s.data = make(map[TKey]TData) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if v, ok := s.data[key]; ok { | ||||||
|  | 		s.data[key] = fn(v) | ||||||
|  | 		return true | ||||||
|  | 	} else { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // UpdateOrInsert updates the value if the key exists, otherwise it inserts the provided `insertValue`. | ||||||
|  | func (s *SyncMap[TKey, TData]) UpdateOrInsert(key TKey, fn func(data TData) TData, insertValue TData) bool { | ||||||
|  | 	s.lock.Lock() | ||||||
|  | 	defer s.lock.Unlock() | ||||||
|  |  | ||||||
|  | 	if s.data == nil { | ||||||
|  | 		s.data = make(map[TKey]TData) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if v, ok := s.data[key]; ok { | ||||||
|  | 		s.data[key] = fn(v) | ||||||
|  | 		return true | ||||||
|  | 	} else { | ||||||
|  | 		s.data[key] = insertValue | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // Clear removes all entries from the map. | ||||||
|  | func (s *SyncMap[TKey, TData]) Clear() { | ||||||
|  | 	s.lock.Lock() | ||||||
|  | 	defer s.lock.Unlock() | ||||||
|  |  | ||||||
|  | 	s.data = make(map[TKey]TData) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // Contains checks if the map contains the provided key. | ||||||
|  | func (s *SyncMap[TKey, TData]) Contains(key TKey) bool { | ||||||
|  | 	s.lock.Lock() | ||||||
|  | 	defer s.lock.Unlock() | ||||||
|  |  | ||||||
|  | 	if s.data == nil { | ||||||
|  | 		s.data = make(map[TKey]TData) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	_, ok := s.data[key] | ||||||
|  |  | ||||||
|  | 	return ok | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // GetAllKeys returns a copy (!) of all keys in the map. | ||||||
|  | func (s *SyncMap[TKey, TData]) GetAllKeys() []TKey { | ||||||
|  | 	s.lock.Lock() | ||||||
|  | 	defer s.lock.Unlock() | ||||||
|  |  | ||||||
|  | 	if s.data == nil { | ||||||
|  | 		s.data = make(map[TKey]TData) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	r := make([]TKey, 0, len(s.data)) | ||||||
|  |  | ||||||
|  | 	for k := range s.data { | ||||||
|  | 		r = append(r, k) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return r | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // GetAllValues returns a copy (!) of all values in the map. | ||||||
|  | func (s *SyncMap[TKey, TData]) GetAllValues() []TData { | ||||||
|  | 	s.lock.Lock() | ||||||
|  | 	defer s.lock.Unlock() | ||||||
|  |  | ||||||
|  | 	if s.data == nil { | ||||||
|  | 		s.data = make(map[TKey]TData) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	r := make([]TData, 0, len(s.data)) | ||||||
|  |  | ||||||
|  | 	for _, v := range s.data { | ||||||
|  | 		r = append(r, v) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return r | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // Count returns the number of entries in the map. | ||||||
|  | func (s *SyncMap[TKey, TData]) Count() int { | ||||||
|  | 	s.lock.Lock() | ||||||
|  | 	defer s.lock.Unlock() | ||||||
|  |  | ||||||
|  | 	if s.data == nil { | ||||||
|  | 		s.data = make(map[TKey]TData) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return len(s.data) | ||||||
|  | } | ||||||
							
								
								
									
										143
									
								
								dataext/syncRingSet.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										143
									
								
								dataext/syncRingSet.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,143 @@ | |||||||
|  | package dataext | ||||||
|  |  | ||||||
|  | import "sync" | ||||||
|  |  | ||||||
|  | type SyncRingSet[TData comparable] struct { | ||||||
|  | 	data map[TData]bool | ||||||
|  | 	lock sync.Mutex | ||||||
|  | 	ring *RingBuffer[TData] | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewSyncRingSet[TData comparable](capacity int) *SyncRingSet[TData] { | ||||||
|  | 	return &SyncRingSet[TData]{ | ||||||
|  | 		data: make(map[TData]bool, capacity+1), | ||||||
|  | 		lock: sync.Mutex{}, | ||||||
|  | 		ring: NewRingBuffer[TData](capacity), | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // Add adds `value` to the set | ||||||
|  | // returns true  if the value was actually inserted (value did not exist beforehand) | ||||||
|  | // returns false if the value already existed | ||||||
|  | func (s *SyncRingSet[TData]) Add(value TData) bool { | ||||||
|  | 	s.lock.Lock() | ||||||
|  | 	defer s.lock.Unlock() | ||||||
|  |  | ||||||
|  | 	if s.data == nil { | ||||||
|  | 		s.data = make(map[TData]bool) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	_, existsInPreState := s.data[value] | ||||||
|  | 	if existsInPreState { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	prev := s.ring.PushPop(value) | ||||||
|  |  | ||||||
|  | 	s.data[value] = true | ||||||
|  | 	if prev != nil { | ||||||
|  | 		delete(s.data, *prev) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return true | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (s *SyncRingSet[TData]) AddAll(values []TData) { | ||||||
|  | 	s.lock.Lock() | ||||||
|  | 	defer s.lock.Unlock() | ||||||
|  |  | ||||||
|  | 	if s.data == nil { | ||||||
|  | 		s.data = make(map[TData]bool) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	for _, value := range values { | ||||||
|  | 		_, existsInPreState := s.data[value] | ||||||
|  | 		if existsInPreState { | ||||||
|  | 			continue | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		prev := s.ring.PushPop(value) | ||||||
|  |  | ||||||
|  | 		s.data[value] = true | ||||||
|  | 		if prev != nil { | ||||||
|  | 			delete(s.data, *prev) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (s *SyncRingSet[TData]) Remove(value TData) bool { | ||||||
|  | 	s.lock.Lock() | ||||||
|  | 	defer s.lock.Unlock() | ||||||
|  |  | ||||||
|  | 	if s.data == nil { | ||||||
|  | 		s.data = make(map[TData]bool) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	_, existsInPreState := s.data[value] | ||||||
|  | 	if !existsInPreState { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	delete(s.data, value) | ||||||
|  | 	s.ring.Remove(func(v TData) bool { return value == v }) | ||||||
|  |  | ||||||
|  | 	return true | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (s *SyncRingSet[TData]) RemoveAll(values []TData) { | ||||||
|  | 	s.lock.Lock() | ||||||
|  | 	defer s.lock.Unlock() | ||||||
|  |  | ||||||
|  | 	if s.data == nil { | ||||||
|  | 		s.data = make(map[TData]bool) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	for _, value := range values { | ||||||
|  | 		delete(s.data, value) | ||||||
|  | 		s.ring.Remove(func(v TData) bool { return value == v }) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (s *SyncRingSet[TData]) Contains(value TData) bool { | ||||||
|  | 	s.lock.Lock() | ||||||
|  | 	defer s.lock.Unlock() | ||||||
|  |  | ||||||
|  | 	if s.data == nil { | ||||||
|  | 		s.data = make(map[TData]bool) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	_, ok := s.data[value] | ||||||
|  |  | ||||||
|  | 	return ok | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (s *SyncRingSet[TData]) Get() []TData { | ||||||
|  | 	s.lock.Lock() | ||||||
|  | 	defer s.lock.Unlock() | ||||||
|  |  | ||||||
|  | 	if s.data == nil { | ||||||
|  | 		s.data = make(map[TData]bool) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	r := make([]TData, 0, len(s.data)) | ||||||
|  |  | ||||||
|  | 	for k := range s.data { | ||||||
|  | 		r = append(r, k) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return r | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // AddIfNotContains | ||||||
|  | // returns true  if the value was actually added (value did not exist beforehand) | ||||||
|  | // returns false if the value already existed | ||||||
|  | func (s *SyncRingSet[TData]) AddIfNotContains(key TData) bool { | ||||||
|  | 	return s.Add(key) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // RemoveIfContains | ||||||
|  | // returns true  if the value was actually removed (value did exist beforehand) | ||||||
|  | // returns false if the value did not exist in the set | ||||||
|  | func (s *SyncRingSet[TData]) RemoveIfContains(key TData) bool { | ||||||
|  | 	return s.Remove(key) | ||||||
|  | } | ||||||
| @@ -7,6 +7,13 @@ type SyncSet[TData comparable] struct { | |||||||
| 	lock sync.Mutex | 	lock sync.Mutex | ||||||
| } | } | ||||||
|  |  | ||||||
|  | func NewSyncSet[TData comparable]() *SyncSet[TData] { | ||||||
|  | 	return &SyncSet[TData]{data: make(map[TData]bool), lock: sync.Mutex{}} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // Add adds `value` to the set | ||||||
|  | // returns true  if the value was actually inserted (value did not exist beforehand) | ||||||
|  | // returns false if the value already existed | ||||||
| func (s *SyncSet[TData]) Add(value TData) bool { | func (s *SyncSet[TData]) Add(value TData) bool { | ||||||
| 	s.lock.Lock() | 	s.lock.Lock() | ||||||
| 	defer s.lock.Unlock() | 	defer s.lock.Unlock() | ||||||
| @@ -15,10 +22,13 @@ func (s *SyncSet[TData]) Add(value TData) bool { | |||||||
| 		s.data = make(map[TData]bool) | 		s.data = make(map[TData]bool) | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	_, ok := s.data[value] | 	_, existsInPreState := s.data[value] | ||||||
| 	s.data[value] = true | 	if existsInPreState { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  |  | ||||||
| 	return !ok | 	s.data[value] = true | ||||||
|  | 	return true | ||||||
| } | } | ||||||
|  |  | ||||||
| func (s *SyncSet[TData]) AddAll(values []TData) { | func (s *SyncSet[TData]) AddAll(values []TData) { | ||||||
| @@ -34,6 +44,36 @@ func (s *SyncSet[TData]) AddAll(values []TData) { | |||||||
| 	} | 	} | ||||||
| } | } | ||||||
|  |  | ||||||
|  | func (s *SyncSet[TData]) Remove(value TData) bool { | ||||||
|  | 	s.lock.Lock() | ||||||
|  | 	defer s.lock.Unlock() | ||||||
|  |  | ||||||
|  | 	if s.data == nil { | ||||||
|  | 		s.data = make(map[TData]bool) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	_, existsInPreState := s.data[value] | ||||||
|  | 	if !existsInPreState { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	delete(s.data, value) | ||||||
|  | 	return true | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (s *SyncSet[TData]) RemoveAll(values []TData) { | ||||||
|  | 	s.lock.Lock() | ||||||
|  | 	defer s.lock.Unlock() | ||||||
|  |  | ||||||
|  | 	if s.data == nil { | ||||||
|  | 		s.data = make(map[TData]bool) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	for _, value := range values { | ||||||
|  | 		delete(s.data, value) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
| func (s *SyncSet[TData]) Contains(value TData) bool { | func (s *SyncSet[TData]) Contains(value TData) bool { | ||||||
| 	s.lock.Lock() | 	s.lock.Lock() | ||||||
| 	defer s.lock.Unlock() | 	defer s.lock.Unlock() | ||||||
| @@ -63,3 +103,17 @@ func (s *SyncSet[TData]) Get() []TData { | |||||||
|  |  | ||||||
| 	return r | 	return r | ||||||
| } | } | ||||||
|  |  | ||||||
|  | // AddIfNotContains | ||||||
|  | // returns true  if the value was actually added (value did not exist beforehand) | ||||||
|  | // returns false if the value already existed | ||||||
|  | func (s *SyncSet[TData]) AddIfNotContains(key TData) bool { | ||||||
|  | 	return s.Add(key) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // RemoveIfContains | ||||||
|  | // returns true  if the value was actually removed (value did exist beforehand) | ||||||
|  | // returns false if the value did not exist in the set | ||||||
|  | func (s *SyncSet[TData]) RemoveIfContains(key TData) bool { | ||||||
|  | 	return s.Remove(key) | ||||||
|  | } | ||||||
|   | |||||||
							
								
								
									
										241
									
								
								dataext/tuple.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										241
									
								
								dataext/tuple.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,241 @@ | |||||||
|  | package dataext | ||||||
|  |  | ||||||
|  | type ValueGroup interface { | ||||||
|  | 	TupleLength() int | ||||||
|  | 	TupleValues() []any | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // ---------------------------------------------------------------------------- | ||||||
|  |  | ||||||
|  | type Single[T1 any] struct { | ||||||
|  | 	V1 T1 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (s Single[T1]) TupleLength() int { | ||||||
|  | 	return 1 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (s Single[T1]) TupleValues() []any { | ||||||
|  | 	return []any{s.V1} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewSingle[T1 any](v1 T1) Single[T1] { | ||||||
|  | 	return Single[T1]{V1: v1} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewTuple1[T1 any](v1 T1) Single[T1] { | ||||||
|  | 	return Single[T1]{V1: v1} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // ---------------------------------------------------------------------------- | ||||||
|  |  | ||||||
|  | type Tuple[T1 any, T2 any] struct { | ||||||
|  | 	V1 T1 | ||||||
|  | 	V2 T2 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (t Tuple[T1, T2]) TupleLength() int { | ||||||
|  | 	return 2 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (t Tuple[T1, T2]) TupleValues() []any { | ||||||
|  | 	return []any{t.V1, t.V2} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewTuple[T1 any, T2 any](v1 T1, v2 T2) Tuple[T1, T2] { | ||||||
|  | 	return Tuple[T1, T2]{V1: v1, V2: v2} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewTuple2[T1 any, T2 any](v1 T1, v2 T2) Tuple[T1, T2] { | ||||||
|  | 	return Tuple[T1, T2]{V1: v1, V2: v2} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // ---------------------------------------------------------------------------- | ||||||
|  |  | ||||||
|  | type Triple[T1 any, T2 any, T3 any] struct { | ||||||
|  | 	V1 T1 | ||||||
|  | 	V2 T2 | ||||||
|  | 	V3 T3 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (t Triple[T1, T2, T3]) TupleLength() int { | ||||||
|  | 	return 3 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (t Triple[T1, T2, T3]) TupleValues() []any { | ||||||
|  | 	return []any{t.V1, t.V2, t.V3} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewTriple[T1 any, T2 any, T3 any](v1 T1, v2 T2, v3 T3) Triple[T1, T2, T3] { | ||||||
|  | 	return Triple[T1, T2, T3]{V1: v1, V2: v2, V3: v3} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewTuple3[T1 any, T2 any, T3 any](v1 T1, v2 T2, v3 T3) Triple[T1, T2, T3] { | ||||||
|  | 	return Triple[T1, T2, T3]{V1: v1, V2: v2, V3: v3} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // ---------------------------------------------------------------------------- | ||||||
|  |  | ||||||
|  | type Quadruple[T1 any, T2 any, T3 any, T4 any] struct { | ||||||
|  | 	V1 T1 | ||||||
|  | 	V2 T2 | ||||||
|  | 	V3 T3 | ||||||
|  | 	V4 T4 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (t Quadruple[T1, T2, T3, T4]) TupleLength() int { | ||||||
|  | 	return 4 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (t Quadruple[T1, T2, T3, T4]) TupleValues() []any { | ||||||
|  | 	return []any{t.V1, t.V2, t.V3, t.V4} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewQuadruple[T1 any, T2 any, T3 any, T4 any](v1 T1, v2 T2, v3 T3, v4 T4) Quadruple[T1, T2, T3, T4] { | ||||||
|  | 	return Quadruple[T1, T2, T3, T4]{V1: v1, V2: v2, V3: v3, V4: v4} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewTuple4[T1 any, T2 any, T3 any, T4 any](v1 T1, v2 T2, v3 T3, v4 T4) Quadruple[T1, T2, T3, T4] { | ||||||
|  | 	return Quadruple[T1, T2, T3, T4]{V1: v1, V2: v2, V3: v3, V4: v4} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // ---------------------------------------------------------------------------- | ||||||
|  |  | ||||||
|  | type Quintuple[T1 any, T2 any, T3 any, T4 any, T5 any] struct { | ||||||
|  | 	V1 T1 | ||||||
|  | 	V2 T2 | ||||||
|  | 	V3 T3 | ||||||
|  | 	V4 T4 | ||||||
|  | 	V5 T5 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (t Quintuple[T1, T2, T3, T4, T5]) TupleLength() int { | ||||||
|  | 	return 5 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (t Quintuple[T1, T2, T3, T4, T5]) TupleValues() []any { | ||||||
|  | 	return []any{t.V1, t.V2, t.V3, t.V4, t.V5} | ||||||
|  |  | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewQuintuple[T1 any, T2 any, T3 any, T4 any, T5 any](v1 T1, v2 T2, v3 T3, v4 T4, v5 T5) Quintuple[T1, T2, T3, T4, T5] { | ||||||
|  | 	return Quintuple[T1, T2, T3, T4, T5]{V1: v1, V2: v2, V3: v3, V4: v4, V5: v5} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewTuple5[T1 any, T2 any, T3 any, T4 any, T5 any](v1 T1, v2 T2, v3 T3, v4 T4, v5 T5) Quintuple[T1, T2, T3, T4, T5] { | ||||||
|  | 	return Quintuple[T1, T2, T3, T4, T5]{V1: v1, V2: v2, V3: v3, V4: v4, V5: v5} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // ---------------------------------------------------------------------------- | ||||||
|  |  | ||||||
|  | type Sextuple[T1 any, T2 any, T3 any, T4 any, T5 any, T6 any] struct { | ||||||
|  | 	V1 T1 | ||||||
|  | 	V2 T2 | ||||||
|  | 	V3 T3 | ||||||
|  | 	V4 T4 | ||||||
|  | 	V5 T5 | ||||||
|  | 	V6 T6 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (t Sextuple[T1, T2, T3, T4, T5, T6]) TupleLength() int { | ||||||
|  | 	return 6 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (t Sextuple[T1, T2, T3, T4, T5, T6]) TupleValues() []any { | ||||||
|  | 	return []any{t.V1, t.V2, t.V3, t.V4, t.V5, t.V6} | ||||||
|  |  | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewSextuple[T1 any, T2 any, T3 any, T4 any, T5 any, T6 any](v1 T1, v2 T2, v3 T3, v4 T4, v5 T5, v6 T6) Sextuple[T1, T2, T3, T4, T5, T6] { | ||||||
|  | 	return Sextuple[T1, T2, T3, T4, T5, T6]{V1: v1, V2: v2, V3: v3, V4: v4, V5: v5, V6: v6} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewTuple6[T1 any, T2 any, T3 any, T4 any, T5 any, T6 any](v1 T1, v2 T2, v3 T3, v4 T4, v5 T5, v6 T6) Sextuple[T1, T2, T3, T4, T5, T6] { | ||||||
|  | 	return Sextuple[T1, T2, T3, T4, T5, T6]{V1: v1, V2: v2, V3: v3, V4: v4, V5: v5, V6: v6} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // ---------------------------------------------------------------------------- | ||||||
|  |  | ||||||
|  | type Septuple[T1 any, T2 any, T3 any, T4 any, T5 any, T6 any, T7 any] struct { | ||||||
|  | 	V1 T1 | ||||||
|  | 	V2 T2 | ||||||
|  | 	V3 T3 | ||||||
|  | 	V4 T4 | ||||||
|  | 	V5 T5 | ||||||
|  | 	V6 T6 | ||||||
|  | 	V7 T7 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (t Septuple[T1, T2, T3, T4, T5, T6, T7]) TupleLength() int { | ||||||
|  | 	return 7 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (t Septuple[T1, T2, T3, T4, T5, T6, T7]) TupleValues() []any { | ||||||
|  | 	return []any{t.V1, t.V2, t.V3, t.V4, t.V5, t.V6, t.V7} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewSeptuple[T1 any, T2 any, T3 any, T4 any, T5 any, T6 any, T7 any](v1 T1, v2 T2, v3 T3, v4 T4, v5 T5, v6 T6, v7 T7) Septuple[T1, T2, T3, T4, T5, T6, T7] { | ||||||
|  | 	return Septuple[T1, T2, T3, T4, T5, T6, T7]{V1: v1, V2: v2, V3: v3, V4: v4, V5: v5, V6: v6, V7: v7} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewTuple7[T1 any, T2 any, T3 any, T4 any, T5 any, T6 any, T7 any](v1 T1, v2 T2, v3 T3, v4 T4, v5 T5, v6 T6, v7 T7) Septuple[T1, T2, T3, T4, T5, T6, T7] { | ||||||
|  | 	return Septuple[T1, T2, T3, T4, T5, T6, T7]{V1: v1, V2: v2, V3: v3, V4: v4, V5: v5, V6: v6, V7: v7} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // ---------------------------------------------------------------------------- | ||||||
|  |  | ||||||
|  | type Octuple[T1 any, T2 any, T3 any, T4 any, T5 any, T6 any, T7 any, T8 any] struct { | ||||||
|  | 	V1 T1 | ||||||
|  | 	V2 T2 | ||||||
|  | 	V3 T3 | ||||||
|  | 	V4 T4 | ||||||
|  | 	V5 T5 | ||||||
|  | 	V6 T6 | ||||||
|  | 	V7 T7 | ||||||
|  | 	V8 T8 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (t Octuple[T1, T2, T3, T4, T5, T6, T7, T8]) TupleLength() int { | ||||||
|  | 	return 8 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (t Octuple[T1, T2, T3, T4, T5, T6, T7, T8]) TupleValues() []any { | ||||||
|  | 	return []any{t.V1, t.V2, t.V3, t.V4, t.V5, t.V6, t.V7, t.V8} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewOctuple[T1 any, T2 any, T3 any, T4 any, T5 any, T6 any, T7 any, T8 any](v1 T1, v2 T2, v3 T3, v4 T4, v5 T5, v6 T6, v7 T7, v8 T8) Octuple[T1, T2, T3, T4, T5, T6, T7, T8] { | ||||||
|  | 	return Octuple[T1, T2, T3, T4, T5, T6, T7, T8]{V1: v1, V2: v2, V3: v3, V4: v4, V5: v5, V6: v6, V7: v7, V8: v8} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewTuple8[T1 any, T2 any, T3 any, T4 any, T5 any, T6 any, T7 any, T8 any](v1 T1, v2 T2, v3 T3, v4 T4, v5 T5, v6 T6, v7 T7, v8 T8) Octuple[T1, T2, T3, T4, T5, T6, T7, T8] { | ||||||
|  | 	return Octuple[T1, T2, T3, T4, T5, T6, T7, T8]{V1: v1, V2: v2, V3: v3, V4: v4, V5: v5, V6: v6, V7: v7, V8: v8} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // ---------------------------------------------------------------------------- | ||||||
|  |  | ||||||
|  | type Nonuple[T1 any, T2 any, T3 any, T4 any, T5 any, T6 any, T7 any, T8 any, T9 any] struct { | ||||||
|  | 	V1 T1 | ||||||
|  | 	V2 T2 | ||||||
|  | 	V3 T3 | ||||||
|  | 	V4 T4 | ||||||
|  | 	V5 T5 | ||||||
|  | 	V6 T6 | ||||||
|  | 	V7 T7 | ||||||
|  | 	V8 T8 | ||||||
|  | 	V9 T9 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (t Nonuple[T1, T2, T3, T4, T5, T6, T7, T8, T9]) TupleLength() int { | ||||||
|  | 	return 9 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (t Nonuple[T1, T2, T3, T4, T5, T6, T7, T8, T9]) TupleValues() []any { | ||||||
|  | 	return []any{t.V1, t.V2, t.V3, t.V4, t.V5, t.V6, t.V7, t.V8, t.V9} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NewNonuple[T1 any, T2 any, T3 any, T4 any, T5 any, T6 any, T7 any, T8 any, T9 any](v1 T1, v2 T2, v3 T3, v4 T4, v5 T5, v6 T6, v7 T7, v8 T8, v9 T9) Nonuple[T1, T2, T3, T4, T5, T6, T7, T8, T9] { | ||||||
|  | 	return Nonuple[T1, T2, T3, T4, T5, T6, T7, T8, T9]{V1: v1, V2: v2, V3: v3, V4: v4, V5: v5, V6: v6, V7: v7, V8: v8, V9: v9} | ||||||
|  | } | ||||||
|  | func NewTuple9[T1 any, T2 any, T3 any, T4 any, T5 any, T6 any, T7 any, T8 any, T9 any](v1 T1, v2 T2, v3 T3, v4 T4, v5 T5, v6 T6, v7 T7, v8 T8, v9 T9) Nonuple[T1, T2, T3, T4, T5, T6, T7, T8, T9] { | ||||||
|  | 	return Nonuple[T1, T2, T3, T4, T5, T6, T7, T8, T9]{V1: v1, V2: v2, V3: v3, V4: v4, V5: v5, V6: v6, V7: v7, V8: v8, V9: v9} | ||||||
|  | } | ||||||
							
								
								
									
										57
									
								
								enums/enum.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										57
									
								
								enums/enum.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,57 @@ | |||||||
|  | package enums | ||||||
|  |  | ||||||
|  | import "encoding/json" | ||||||
|  |  | ||||||
|  | type Enum interface { | ||||||
|  | 	Valid() bool | ||||||
|  | 	ValuesAny() []any | ||||||
|  | 	ValuesMeta() []EnumMetaValue | ||||||
|  | 	VarName() string | ||||||
|  | 	TypeName() string | ||||||
|  | 	PackageName() string | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type StringEnum interface { | ||||||
|  | 	Enum | ||||||
|  | 	String() string | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type DescriptionEnum interface { | ||||||
|  | 	Enum | ||||||
|  | 	Description() string | ||||||
|  | 	DescriptionMeta() EnumDescriptionMetaValue | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type EnumMetaValue struct { | ||||||
|  | 	VarName     string  `json:"varName"` | ||||||
|  | 	Value       Enum    `json:"value"` | ||||||
|  | 	Description *string `json:"description"` | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type EnumDescriptionMetaValue struct { | ||||||
|  | 	VarName     string `json:"varName"` | ||||||
|  | 	Value       Enum   `json:"value"` | ||||||
|  | 	Description string `json:"description"` | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type EnumDataMetaValue struct { | ||||||
|  | 	VarName     string  `json:"varName"` | ||||||
|  | 	Value       Enum    `json:"value"` | ||||||
|  | 	Description *string `json:"description"` | ||||||
|  |  | ||||||
|  | 	Data map[string]any `json:"-"` //handled by MarshalJSON | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (v EnumDataMetaValue) MarshalJSON() ([]byte, error) { | ||||||
|  | 	m := make(map[string]any, 8) | ||||||
|  |  | ||||||
|  | 	for k, dv := range v.Data { | ||||||
|  | 		m[k] = dv | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	m["varName"] = v.VarName | ||||||
|  | 	m["value"] = v.Value | ||||||
|  | 	m["description"] = v.Description | ||||||
|  |  | ||||||
|  | 	return json.Marshal(m) | ||||||
|  | } | ||||||
							
								
								
									
										344
									
								
								exerr/builder.go
									
									
									
									
									
								
							
							
						
						
									
										344
									
								
								exerr/builder.go
									
									
									
									
									
								
							| @@ -2,36 +2,45 @@ package exerr | |||||||
|  |  | ||||||
| import ( | import ( | ||||||
| 	"bytes" | 	"bytes" | ||||||
|  | 	"context" | ||||||
| 	"encoding/json" | 	"encoding/json" | ||||||
| 	"fmt" | 	"fmt" | ||||||
| 	"github.com/rs/zerolog" |  | ||||||
| 	"go.mongodb.org/mongo-driver/bson/primitive" |  | ||||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/langext" |  | ||||||
| 	"net/http" | 	"net/http" | ||||||
| 	"os" | 	"os" | ||||||
| 	"runtime/debug" | 	"runtime/debug" | ||||||
| 	"strings" | 	"strings" | ||||||
| 	"time" | 	"time" | ||||||
|  |  | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/dataext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/enums" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | 	"github.com/gin-gonic/gin" | ||||||
|  | 	"github.com/rs/zerolog" | ||||||
|  | 	"go.mongodb.org/mongo-driver/bson/primitive" | ||||||
| ) | ) | ||||||
|  |  | ||||||
| // | // | ||||||
| // ==== USAGE ===== | // ==== USAGE ===== | ||||||
| // | // | ||||||
| // If some method returns an error _always wrap it into an bmerror: | // If some method returns an error _always wrap it into an exerror: | ||||||
| //     value, err := do_something(..) | //     value, err := do_something(..) | ||||||
| //     if err != nil { | //     if err != nil { | ||||||
| //         return nil, bmerror.Wrap(err, "do something failed").Build() | //         return nil, exerror.Wrap(err, "do something failed").Build() | ||||||
| //     } | //     } | ||||||
| // | // | ||||||
| // If possible add metadata to the error (eg the id that was not found, ...), the methods are the same as in zerolog | // If possible add metadata to the error (eg the id that was not found, ...), the methods are the same as in zerolog | ||||||
| //     return nil, bmerror.Wrap(err, "do something failed").Str("someid", id).Int("count", in.Count).Build() | //     return nil, exerror.Wrap(err, "do something failed").Str("someid", id).Int("count", in.Count).Build() | ||||||
|  | // | ||||||
|  | // You can also add extra-data to an error with Extra(..) | ||||||
|  | // in contrast to metadata is extradata always printed in the resulting error and is more intended for additional (programmatically readable) data in addition to the errortype | ||||||
|  | // (metadata is more internal debug info/help) | ||||||
| // | // | ||||||
| // You can change the errortype with `.User()` and `.System()` (User-errors are 400 and System-errors 500) | // You can change the errortype with `.User()` and `.System()` (User-errors are 400 and System-errors 500) | ||||||
| // You can also manually set the statuscode with `.WithStatuscode(http.NotFound)` | // You can also manually set the statuscode with `.WithStatuscode(http.NotFound)` | ||||||
| // You can set the type with `WithType(..)` | // You can set the type with `WithType(..)` | ||||||
| // | // | ||||||
| // New Errors (that don't wrap an existing err object) are created with New | // New Errors (that don't wrap an existing err object) are created with New | ||||||
| //     return nil, bmerror.New(bmerror.ErrInternal, "womethign wen horrible wrong").Build() | //     return nil, exerror.New(exerror.TypeInternal, "womethign wen horrible wrong").Build() | ||||||
| // You can eitehr use an existing ErrorType, the "catch-all" ErrInternal, or add you own ErrType in consts.go | // You can eitehr use an existing ErrorType, the "catch-all" ErrInternal, or add you own ErrType in consts.go | ||||||
| // | // | ||||||
| // All errors should be handled one of the following four ways: | // All errors should be handled one of the following four ways: | ||||||
| @@ -51,50 +60,61 @@ import ( | |||||||
| //     => Wrap/New + Fatal | //     => Wrap/New + Fatal | ||||||
| // | // | ||||||
|  |  | ||||||
| var stackSkipLogger zerolog.Logger |  | ||||||
|  |  | ||||||
| func init() { |  | ||||||
| 	cw := zerolog.ConsoleWriter{ |  | ||||||
| 		Out:        os.Stdout, |  | ||||||
| 		TimeFormat: "2006-01-02 15:04:05 Z07:00", |  | ||||||
| 	} |  | ||||||
|  |  | ||||||
| 	multi := zerolog.MultiLevelWriter(cw) |  | ||||||
| 	stackSkipLogger = zerolog.New(multi).With().Timestamp().CallerWithSkipFrameCount(4).Logger() |  | ||||||
| } |  | ||||||
|  |  | ||||||
| type Builder struct { | type Builder struct { | ||||||
| 	bmerror *bringmanError | 	wrappedErr          error | ||||||
|  | 	errorData           *ExErr | ||||||
| 	containsGinData bool | 	containsGinData     bool | ||||||
|  | 	containsContextData bool | ||||||
|  | 	noLog               bool | ||||||
| } | } | ||||||
|  |  | ||||||
| func Get(err error) *Builder { | func Get(err error) *Builder { | ||||||
| 	return &Builder{bmerror: fromError(err)} | 	return &Builder{errorData: FromError(err)} | ||||||
| } | } | ||||||
|  |  | ||||||
| func New(t ErrorType, msg string) *Builder { | func New(t ErrorType, msg string) *Builder { | ||||||
| 	return &Builder{bmerror: newBringmanErr(CatSystem, t, msg)} | 	return &Builder{errorData: newExErr(CatSystem, t, msg)} | ||||||
| } | } | ||||||
|  |  | ||||||
| func Wrap(err error, msg string) *Builder { | func Wrap(err error, msg string) *Builder { | ||||||
| 	return &Builder{bmerror: fromError(err).wrap(msg, CatWrap, 1)} | 	if err == nil { | ||||||
|  | 		return &Builder{errorData: newExErr(CatSystem, TypeInternal, msg)} // prevent NPE if we call Wrap with err==nil | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	v := FromError(err) | ||||||
|  |  | ||||||
|  | 	if !pkgconfig.RecursiveErrors { | ||||||
|  | 		v.Message = msg | ||||||
|  | 		return &Builder{wrappedErr: err, errorData: v} | ||||||
|  | 	} else { | ||||||
|  | 		return &Builder{wrappedErr: err, errorData: wrapExErr(v, msg, CatWrap, 1)} | ||||||
|  | 	} | ||||||
| } | } | ||||||
|  |  | ||||||
| // ---------------------------------------------------------------------------- | // ---------------------------------------------------------------------------- | ||||||
|  |  | ||||||
| func (b *Builder) WithType(t ErrorType) *Builder { | func (b *Builder) WithType(t ErrorType) *Builder { | ||||||
| 	b.bmerror.Type = t | 	b.errorData.Type = t | ||||||
| 	return b | 	return b | ||||||
| } | } | ||||||
|  |  | ||||||
| func (b *Builder) WithStatuscode(status int) *Builder { | func (b *Builder) WithStatuscode(status int) *Builder { | ||||||
| 	b.bmerror.StatusCode = status | 	b.errorData.StatusCode = &status | ||||||
| 	return b | 	return b | ||||||
| } | } | ||||||
|  |  | ||||||
| func (b *Builder) WithMessage(msg string) *Builder { | func (b *Builder) WithMessage(msg string) *Builder { | ||||||
| 	b.bmerror.Message = msg | 	b.errorData.Message = msg | ||||||
|  | 	return b | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (b *Builder) WithSeverity(v ErrorSeverity) *Builder { | ||||||
|  | 	b.errorData.Severity = v | ||||||
|  | 	return b | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (b *Builder) WithCategory(v ErrorCategory) *Builder { | ||||||
|  | 	b.errorData.Category = v | ||||||
| 	return b | 	return b | ||||||
| } | } | ||||||
|  |  | ||||||
| @@ -119,7 +139,7 @@ func (b *Builder) WithMessage(msg string) *Builder { | |||||||
| // | // | ||||||
| //   - Send to the error-service | //   - Send to the error-service | ||||||
| func (b *Builder) Err() *Builder { | func (b *Builder) Err() *Builder { | ||||||
| 	b.bmerror.Severity = SevErr | 	b.errorData.Severity = SevErr | ||||||
| 	return b | 	return b | ||||||
| } | } | ||||||
|  |  | ||||||
| @@ -138,7 +158,7 @@ func (b *Builder) Err() *Builder { | |||||||
| // | // | ||||||
| //   - Logged as Warn | //   - Logged as Warn | ||||||
| func (b *Builder) Warn() *Builder { | func (b *Builder) Warn() *Builder { | ||||||
| 	b.bmerror.Severity = SevWarn | 	b.errorData.Severity = SevWarn | ||||||
| 	return b | 	return b | ||||||
| } | } | ||||||
|  |  | ||||||
| @@ -157,7 +177,7 @@ func (b *Builder) Warn() *Builder { | |||||||
| // | // | ||||||
| //   - -(nothing)- | //   - -(nothing)- | ||||||
| func (b *Builder) Info() *Builder { | func (b *Builder) Info() *Builder { | ||||||
| 	b.bmerror.Severity = SevInfo | 	b.errorData.Severity = SevInfo | ||||||
| 	return b | 	return b | ||||||
| } | } | ||||||
|  |  | ||||||
| @@ -167,12 +187,19 @@ func (b *Builder) Info() *Builder { | |||||||
| // | // | ||||||
| // Errors with category | // Errors with category | ||||||
| func (b *Builder) User() *Builder { | func (b *Builder) User() *Builder { | ||||||
| 	b.bmerror.Category = CatUser | 	b.errorData.Category = CatUser | ||||||
| 	return b | 	return b | ||||||
| } | } | ||||||
|  |  | ||||||
| func (b *Builder) System() *Builder { | func (b *Builder) System() *Builder { | ||||||
| 	b.bmerror.Category = CatSystem | 	b.errorData.Category = CatSystem | ||||||
|  | 	return b | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // ---------------------------------------------------------------------------- | ||||||
|  |  | ||||||
|  | func (b *Builder) NoLog() *Builder { | ||||||
|  | 	b.noLog = true | ||||||
| 	return b | 	return b | ||||||
| } | } | ||||||
|  |  | ||||||
| @@ -262,13 +289,25 @@ func (b *Builder) Any(key string, val any) *Builder { | |||||||
| 	return b.addMeta(key, MDTAny, newAnyWrap(val)) | 	return b.addMeta(key, MDTAny, newAnyWrap(val)) | ||||||
| } | } | ||||||
|  |  | ||||||
|  | func (b *Builder) Stringer(key string, val fmt.Stringer) *Builder { | ||||||
|  | 	if langext.IsNil(val) { | ||||||
|  | 		return b.addMeta(key, MDTString, "(!nil)") | ||||||
|  | 	} else { | ||||||
|  | 		return b.addMeta(key, MDTString, val.String()) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (b *Builder) Enum(key string, val enums.Enum) *Builder { | ||||||
|  | 	return b.addMeta(key, MDTEnum, newEnumWrap(val)) | ||||||
|  | } | ||||||
|  |  | ||||||
| func (b *Builder) Stack() *Builder { | func (b *Builder) Stack() *Builder { | ||||||
| 	return b.addMeta("@Stack", MDTString, string(debug.Stack())) | 	return b.addMeta("@Stack", MDTString, string(debug.Stack())) | ||||||
| } | } | ||||||
|  |  | ||||||
| func (b *Builder) Errs(key string, val []error) *Builder { | func (b *Builder) Errs(key string, val []error) *Builder { | ||||||
| 	for i, valerr := range val { | 	for i, valerr := range val { | ||||||
| 		b.addMeta(fmt.Sprintf("%v[%v]", key, i), MDTString, Get(valerr).toBMError().FormatLog(LogPrintFull)) | 		b.addMeta(fmt.Sprintf("%v[%v]", key, i), MDTString, Get(valerr).errorData.FormatLog(LogPrintFull)) | ||||||
| 	} | 	} | ||||||
| 	return b | 	return b | ||||||
| } | } | ||||||
| @@ -276,68 +315,86 @@ func (b *Builder) Errs(key string, val []error) *Builder { | |||||||
| func (b *Builder) GinReq(ctx context.Context, g *gin.Context, req *http.Request) *Builder { | func (b *Builder) GinReq(ctx context.Context, g *gin.Context, req *http.Request) *Builder { | ||||||
| 	if v := ctx.Value("start_timestamp"); v != nil { | 	if v := ctx.Value("start_timestamp"); v != nil { | ||||||
| 		if t, ok := v.(time.Time); ok { | 		if t, ok := v.(time.Time); ok { | ||||||
| 			b.Time("ctx.startTimestamp", t) | 			b.Time("ctx_startTimestamp", t) | ||||||
| 			b.Time("ctx.endTimestamp", time.Now()) | 			b.Time("ctx_endTimestamp", time.Now()) | ||||||
| 		} | 		} | ||||||
| 	} | 	} | ||||||
| 	b.Str("gin.method", req.Method) | 	b.Str("gin_method", req.Method) | ||||||
| 	b.Str("gin.path", g.FullPath()) | 	b.Str("gin_host", req.Host) | ||||||
| 	b.Str("gin.header", formatHeader(g.Request.Header)) | 	b.Str("gin_path", g.FullPath()) | ||||||
|  | 	b.Strs("gin_header", extractHeader(g.Request.Header)) | ||||||
| 	if req.URL != nil { | 	if req.URL != nil { | ||||||
| 		b.Str("gin.url", req.URL.String()) | 		b.Str("gin_url", req.URL.String()) | ||||||
| 	} | 	} | ||||||
| 	if ctxVal := g.GetString("apiversion"); ctxVal != "" { | 	if ctxVal := g.GetString("apiversion"); ctxVal != "" { | ||||||
| 		b.Str("gin.context.apiversion", ctxVal) | 		b.Str("gin_context_apiversion", ctxVal) | ||||||
| 	} | 	} | ||||||
| 	if ctxVal := g.GetString("uid"); ctxVal != "" { | 	if ctxVal := g.GetString("uid"); ctxVal != "" { | ||||||
| 		b.Str("gin.context.uid", ctxVal) | 		b.Str("gin_context_uid", ctxVal) | ||||||
| 	} | 	} | ||||||
| 	if ctxVal := g.GetString("fcmId"); ctxVal != "" { | 	if ctxVal := g.GetString("fcmId"); ctxVal != "" { | ||||||
| 		b.Str("gin.context.fcmid", ctxVal) | 		b.Str("gin_context_fcmid", ctxVal) | ||||||
| 	} | 	} | ||||||
| 	if ctxVal := g.GetString("reqid"); ctxVal != "" { | 	if ctxVal := g.GetString("reqid"); ctxVal != "" { | ||||||
| 		b.Str("gin.context.reqid", ctxVal) | 		b.Str("gin_context_reqid", ctxVal) | ||||||
| 	} | 	} | ||||||
| 	if req.Method != "GET" && req.Body != nil && req.Header.Get("Content-Type") == "application/json" { | 	if req.Method != "GET" && req.Body != nil { | ||||||
| 		if brc, ok := req.Body.(langext.BufferedReadCloser); ok { |  | ||||||
| 			if bin, err := brc.BufferedAll(); err == nil { | 		if req.Header.Get("Content-Type") == "application/json" { | ||||||
| 				if len(bin) < 16*1024 { | 			if brc, ok := req.Body.(dataext.BufferedReadCloser); ok { | ||||||
| 					var prettyJSON bytes.Buffer | 				if bin, err := brc.BufferedAll(); err == nil { | ||||||
| 					err = json.Indent(&prettyJSON, bin, "", "  ") | 					if len(bin) < 16*1024 { | ||||||
| 					if err == nil { | 						var prettyJSON bytes.Buffer | ||||||
| 						b.Str("gin.body", string(prettyJSON.Bytes())) | 						err = json.Indent(&prettyJSON, bin, "", "  ") | ||||||
|  | 						if err == nil { | ||||||
|  | 							b.Str("gin_body", string(prettyJSON.Bytes())) | ||||||
|  | 						} else { | ||||||
|  | 							b.Bytes("gin_body", bin) | ||||||
|  | 						} | ||||||
| 					} else { | 					} else { | ||||||
| 						b.Bytes("gin.body", bin) | 						b.Str("gin_body", fmt.Sprintf("[[%v bytes | %s]]", len(bin), req.Header.Get("Content-Type"))) | ||||||
| 					} | 					} | ||||||
| 				} else { |  | ||||||
| 					b.Str("gin.body", fmt.Sprintf("[[%v bytes]]", len(bin))) |  | ||||||
| 				} | 				} | ||||||
| 			} | 			} | ||||||
| 		} | 		} | ||||||
|  |  | ||||||
|  | 		if req.Header.Get("Content-Type") == "multipart/form-data" || req.Header.Get("Content-Type") == "x-www-form-urlencoded" { | ||||||
|  | 			if brc, ok := req.Body.(dataext.BufferedReadCloser); ok { | ||||||
|  | 				if bin, err := brc.BufferedAll(); err == nil { | ||||||
|  | 					if len(bin) < 16*1024 { | ||||||
|  | 						b.Bytes("gin_body", bin) | ||||||
|  | 					} else { | ||||||
|  | 						b.Str("gin_body", fmt.Sprintf("[[%v bytes | %s]]", len(bin), req.Header.Get("Content-Type"))) | ||||||
|  | 					} | ||||||
|  | 				} | ||||||
|  | 			} | ||||||
|  | 		} | ||||||
|  |  | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
|  | 	pkgconfig.ExtendGinMeta(ctx, b, g, req) | ||||||
|  |  | ||||||
| 	b.containsGinData = true | 	b.containsGinData = true | ||||||
| 	return b | 	return b | ||||||
| } | } | ||||||
|  |  | ||||||
| func formatHeader(header map[string][]string) string { | func (b *Builder) CtxData(method Method, ctx context.Context) *Builder { | ||||||
| 	ml := 1 | 	pkgconfig.ExtendContextMeta(b, method, ctx) | ||||||
| 	for k, _ := range header { |  | ||||||
| 		if len(k) > ml { | 	b.containsContextData = true | ||||||
| 			ml = len(k) |  | ||||||
| 		} | 	return b | ||||||
| 	} | } | ||||||
| 	r := "" |  | ||||||
|  | func extractHeader(header map[string][]string) []string { | ||||||
|  | 	r := make([]string, 0, len(header)) | ||||||
| 	for k, v := range header { | 	for k, v := range header { | ||||||
| 		if r != "" { |  | ||||||
| 			r += "\n" |  | ||||||
| 		} |  | ||||||
| 		for _, hval := range v { | 		for _, hval := range v { | ||||||
| 			value := hval | 			value := hval | ||||||
| 			value = strings.ReplaceAll(value, "\n", "\\n") | 			value = strings.ReplaceAll(value, "\n", "\\n") | ||||||
| 			value = strings.ReplaceAll(value, "\r", "\\r") | 			value = strings.ReplaceAll(value, "\r", "\\r") | ||||||
| 			value = strings.ReplaceAll(value, "\t", "\\t") | 			value = strings.ReplaceAll(value, "\t", "\\t") | ||||||
| 			r += langext.StrPadRight(k, " ", ml) + " := " + value | 			r = append(r, k+": "+value) | ||||||
| 		} | 		} | ||||||
| 	} | 	} | ||||||
| 	return r | 	return r | ||||||
| @@ -345,72 +402,171 @@ func formatHeader(header map[string][]string) string { | |||||||
|  |  | ||||||
| // ---------------------------------------------------------------------------- | // ---------------------------------------------------------------------------- | ||||||
|  |  | ||||||
|  | // Extra adds additional data to the error | ||||||
|  | // this is not like the other metadata (like Id(), Str(), etc) | ||||||
|  | // this data is public and will be printed/outputted | ||||||
|  | func (b *Builder) Extra(key string, val any) *Builder { | ||||||
|  | 	b.errorData.Extra[key] = val | ||||||
|  | 	return b | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // ---------------------------------------------------------------------------- | ||||||
|  |  | ||||||
| // Build creates a new error, ready to pass up the stack | // Build creates a new error, ready to pass up the stack | ||||||
| // If the errors is not SevWarn or SevInfo it gets also logged (in short form, without stacktrace) onto stdout | // If the errors is not SevWarn or SevInfo it gets also logged (in short form, without stacktrace) onto stdout | ||||||
| func (b *Builder) Build() error { | // Can be gloablly configured with ZeroLogErrTraces and ZeroLogAllTraces | ||||||
| 	if b.bmerror.Severity == SevErr || b.bmerror.Severity == SevFatal { | // Can be locally suppressed with Builder.NoLog() | ||||||
| 		b.bmerror.ShortLog(stackSkipLogger.Error()) | func (b *Builder) Build(ctxs ...context.Context) error { | ||||||
|  | 	return b.BuildAsExerr(ctxs...) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (b *Builder) BuildAsExerr(ctxs ...context.Context) *ExErr { | ||||||
|  | 	warnOnPkgConfigNotInitialized() | ||||||
|  |  | ||||||
|  | 	for _, dctx := range ctxs { | ||||||
|  | 		b.CtxData(MethodBuild, dctx) | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	b.CallListener(MethodBuild) | 	if pkgconfig.DisableErrorWrapping && b.wrappedErr != nil { | ||||||
|  | 		return FromError(b.wrappedErr) | ||||||
|  | 	} | ||||||
|  |  | ||||||
| 	return b.bmerror.ToGrpcError() | 	if pkgconfig.ZeroLogErrTraces && !b.noLog { | ||||||
|  | 		if b.errorData.Severity == SevErr || b.errorData.Severity == SevFatal { | ||||||
|  | 			b.errorData.ShortLog(pkgconfig.ZeroLogger.Error()) | ||||||
|  | 		} else if b.errorData.Severity == SevWarn { | ||||||
|  | 			b.errorData.ShortLog(pkgconfig.ZeroLogger.Warn()) | ||||||
|  | 		} else if b.errorData.Severity == SevInfo { | ||||||
|  | 			b.errorData.ShortLog(pkgconfig.ZeroLogger.Info()) | ||||||
|  | 		} else if b.errorData.Severity == SevDebug { | ||||||
|  | 			b.errorData.ShortLog(pkgconfig.ZeroLogger.Debug()) | ||||||
|  | 		} else if b.errorData.Severity == SevTrace { | ||||||
|  | 			b.errorData.ShortLog(pkgconfig.ZeroLogger.Trace()) | ||||||
|  | 		} else { | ||||||
|  | 			b.errorData.ShortLog(pkgconfig.ZeroLogger.Error()) // ?!? unknown severity | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 	} | ||||||
|  | 	b.errorData.CallListener(MethodBuild, ListenerOpt{NoLog: b.noLog}) | ||||||
|  |  | ||||||
|  | 	return b.errorData | ||||||
| } | } | ||||||
|  |  | ||||||
| // Output prints the error onto the gin stdout. | // Output prints the error onto the gin stdout. | ||||||
| // The error also gets printed to stdout/stderr | // The error also gets printed to stdout/stderr | ||||||
| // If the error is SevErr|SevFatal we also send it to the error-service | // If the error is SevErr|SevFatal we also send it to the error-service | ||||||
| func (b *Builder) Output(ctx context.Context, g *gin.Context) { | func (b *Builder) Output(ctx context.Context, g *gin.Context) { | ||||||
|  | 	warnOnPkgConfigNotInitialized() | ||||||
|  |  | ||||||
| 	if !b.containsGinData && g.Request != nil { | 	if !b.containsGinData && g.Request != nil { | ||||||
| 		// Auto-Add gin metadata if the caller hasn't already done it | 		// Auto-Add gin metadata if the caller hasn't already done it | ||||||
| 		b.GinReq(ctx, g, g.Request) | 		b.GinReq(ctx, g, g.Request) | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	b.bmerror.Output(ctx, g) | 	b.CtxData(MethodOutput, ctx) | ||||||
|  |  | ||||||
| 	if b.bmerror.Severity == SevErr || b.bmerror.Severity == SevFatal { | 	// this is only here to add one level to the trace | ||||||
| 		b.bmerror.Log(stackSkipLogger.Error()) | 	// so that .Build() and .Output() and .Print() have the same depth and our stack-skip logger can have the same skip-count | ||||||
| 	} else if b.bmerror.Severity == SevWarn { | 	b.doGinOutput(ctx, g) | ||||||
| 		b.bmerror.Log(stackSkipLogger.Warn()) | } | ||||||
|  |  | ||||||
|  | // OutputRaw works teh same as Output() - but does not depend on gin and works with a raw http.ResponseWriter | ||||||
|  | func (b *Builder) OutputRaw(w http.ResponseWriter) { | ||||||
|  | 	warnOnPkgConfigNotInitialized() | ||||||
|  |  | ||||||
|  | 	// this is only here to add one level to the trace | ||||||
|  | 	// so that .Build() and .Output() and .Print() have the same depth and our stack-skip logger can have the same skip-count | ||||||
|  | 	b.doRawOutput(w) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (b *Builder) doGinOutput(ctx context.Context, g *gin.Context) { | ||||||
|  | 	b.errorData.Output(g) | ||||||
|  |  | ||||||
|  | 	if (b.errorData.Severity == SevErr || b.errorData.Severity == SevFatal) && (pkgconfig.ZeroLogErrGinOutput || pkgconfig.ZeroLogAllGinOutput) { | ||||||
|  | 		b.errorData.Log(pkgconfig.ZeroLogger.Error()) | ||||||
|  | 	} else if (b.errorData.Severity == SevWarn) && (pkgconfig.ZeroLogAllGinOutput) { | ||||||
|  | 		b.errorData.Log(pkgconfig.ZeroLogger.Warn()) | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	b.CallListener(MethodOutput) | 	b.errorData.CallListener(MethodOutput, ListenerOpt{NoLog: b.noLog}) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (b *Builder) doRawOutput(w http.ResponseWriter) { | ||||||
|  | 	b.errorData.OutputRaw(w) | ||||||
|  |  | ||||||
|  | 	if (b.errorData.Severity == SevErr || b.errorData.Severity == SevFatal) && (pkgconfig.ZeroLogErrGinOutput || pkgconfig.ZeroLogAllGinOutput) { | ||||||
|  | 		b.errorData.Log(pkgconfig.ZeroLogger.Error()) | ||||||
|  | 	} else if (b.errorData.Severity == SevWarn) && (pkgconfig.ZeroLogAllGinOutput) { | ||||||
|  | 		b.errorData.Log(pkgconfig.ZeroLogger.Warn()) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	b.errorData.CallListener(MethodOutput, ListenerOpt{NoLog: b.noLog}) | ||||||
| } | } | ||||||
|  |  | ||||||
| // Print prints the error | // Print prints the error | ||||||
| // If the error is SevErr we also send it to the error-service | // If the error is SevErr we also send it to the error-service | ||||||
| func (b *Builder) Print() { | func (b *Builder) Print(ctxs ...context.Context) Proxy { | ||||||
| 	if b.bmerror.Severity == SevErr || b.bmerror.Severity == SevFatal { | 	warnOnPkgConfigNotInitialized() | ||||||
| 		b.bmerror.Log(stackSkipLogger.Error()) |  | ||||||
| 	} else if b.bmerror.Severity == SevWarn { | 	for _, dctx := range ctxs { | ||||||
| 		b.bmerror.ShortLog(stackSkipLogger.Warn()) | 		b.CtxData(MethodPrint, dctx) | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	b.CallListener(MethodPrint) | 	// this is only here to add one level to the trace | ||||||
|  | 	// so that .Build() and .Output() and .Print() have the same depth and our stack-skip logger can have the same skip-count | ||||||
|  | 	return b.doPrint() | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (b *Builder) doPrint() Proxy { | ||||||
|  | 	if b.errorData.Severity == SevErr || b.errorData.Severity == SevFatal { | ||||||
|  | 		b.errorData.Log(pkgconfig.ZeroLogger.Error()) | ||||||
|  | 	} else if b.errorData.Severity == SevWarn { | ||||||
|  | 		b.errorData.ShortLog(pkgconfig.ZeroLogger.Warn()) | ||||||
|  | 	} else if b.errorData.Severity == SevInfo { | ||||||
|  | 		b.errorData.ShortLog(pkgconfig.ZeroLogger.Info()) | ||||||
|  | 	} else if b.errorData.Severity == SevDebug { | ||||||
|  | 		b.errorData.ShortLog(pkgconfig.ZeroLogger.Debug()) | ||||||
|  | 	} else if b.errorData.Severity == SevTrace { | ||||||
|  | 		b.errorData.ShortLog(pkgconfig.ZeroLogger.Trace()) | ||||||
|  | 	} else { | ||||||
|  | 		b.errorData.Log(pkgconfig.ZeroLogger.Error()) // ?!? unknown severity | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	b.errorData.CallListener(MethodPrint, ListenerOpt{NoLog: b.noLog}) | ||||||
|  |  | ||||||
|  | 	return Proxy{v: *b.errorData} // we return Proxy<Exerr> here instead of Exerr to prevent warnings on ignored err-returns | ||||||
| } | } | ||||||
|  |  | ||||||
| func (b *Builder) Format(level LogPrintLevel) string { | func (b *Builder) Format(level LogPrintLevel) string { | ||||||
| 	return b.bmerror.FormatLog(level) | 	return b.errorData.FormatLog(level) | ||||||
| } | } | ||||||
|  |  | ||||||
| // Fatal prints the error and terminates the program | // Fatal prints the error and terminates the program | ||||||
| // If the error is SevErr we also send it to the error-service | // If the error is SevErr we also send it to the error-service | ||||||
| func (b *Builder) Fatal() { | func (b *Builder) Fatal(ctxs ...context.Context) { | ||||||
| 	b.bmerror.Severity = SevFatal |  | ||||||
| 	b.bmerror.Log(stackSkipLogger.WithLevel(zerolog.FatalLevel)) |  | ||||||
|  |  | ||||||
| 	b.CallListener(MethodFatal) | 	b.errorData.Severity = SevFatal | ||||||
|  |  | ||||||
|  | 	for _, dctx := range ctxs { | ||||||
|  | 		b.CtxData(MethodFatal, dctx) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// this is only here to add one level to the trace | ||||||
|  | 	// so that .Build() and .Output() and .Print() have the same depth and our stack-skip logger can have the same skip-count | ||||||
|  | 	b.doLogFatal() | ||||||
|  |  | ||||||
|  | 	b.errorData.CallListener(MethodFatal, ListenerOpt{NoLog: b.noLog}) | ||||||
|  |  | ||||||
| 	os.Exit(1) | 	os.Exit(1) | ||||||
| } | } | ||||||
|  |  | ||||||
|  | func (b *Builder) doLogFatal() { | ||||||
|  | 	b.errorData.Log(pkgconfig.ZeroLogger.WithLevel(zerolog.FatalLevel)) | ||||||
|  | } | ||||||
|  |  | ||||||
| // ---------------------------------------------------------------------------- | // ---------------------------------------------------------------------------- | ||||||
|  |  | ||||||
| func (b *Builder) addMeta(key string, mdtype metaDataType, val interface{}) *Builder { | func (b *Builder) addMeta(key string, mdtype metaDataType, val interface{}) *Builder { | ||||||
| 	b.bmerror.Meta.add(key, mdtype, val) | 	b.errorData.Meta.add(key, mdtype, val) | ||||||
| 	return b | 	return b | ||||||
| } | } | ||||||
|  |  | ||||||
| func (b *Builder) toBMError() BMError { |  | ||||||
| 	return b.bmerror.ToBMError() |  | ||||||
| } |  | ||||||
|   | |||||||
							
								
								
									
										274
									
								
								exerr/constructor.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										274
									
								
								exerr/constructor.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,274 @@ | |||||||
|  | package exerr | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"encoding/json" | ||||||
|  | 	"fmt" | ||||||
|  | 	"go.mongodb.org/mongo-driver/bson/primitive" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | 	"reflect" | ||||||
|  | 	"time" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | var reflectTypeStr = reflect.TypeOf("") | ||||||
|  |  | ||||||
|  | func FromError(err error) *ExErr { | ||||||
|  |  | ||||||
|  | 	if err == nil { | ||||||
|  | 		// prevent NPE if we call FromError with err==nil | ||||||
|  | 		return &ExErr{ | ||||||
|  | 			UniqueID:       newID(), | ||||||
|  | 			Category:       CatForeign, | ||||||
|  | 			Type:           TypeInternal, | ||||||
|  | 			Severity:       SevErr, | ||||||
|  | 			Timestamp:      time.Time{}, | ||||||
|  | 			StatusCode:     nil, | ||||||
|  | 			Message:        "", | ||||||
|  | 			WrappedErrType: "nil", | ||||||
|  | 			WrappedErr:     err, | ||||||
|  | 			Caller:         "", | ||||||
|  | 			OriginalError:  nil, | ||||||
|  | 			Meta:           make(MetaMap), | ||||||
|  | 			Extra:          make(map[string]any), | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	//goland:noinspection GoTypeAssertionOnErrors | ||||||
|  | 	if verr, ok := err.(*ExErr); ok { | ||||||
|  | 		// A simple ExErr | ||||||
|  | 		return verr | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	//goland:noinspection GoTypeAssertionOnErrors | ||||||
|  | 	if verr, ok := err.(langext.PanicWrappedErr); ok { | ||||||
|  | 		return &ExErr{ | ||||||
|  | 			UniqueID:       newID(), | ||||||
|  | 			Category:       CatForeign, | ||||||
|  | 			Type:           TypePanic, | ||||||
|  | 			Severity:       SevErr, | ||||||
|  | 			Timestamp:      time.Time{}, | ||||||
|  | 			StatusCode:     nil, | ||||||
|  | 			Message:        "A panic occured", | ||||||
|  | 			WrappedErrType: fmt.Sprintf("%T", verr), | ||||||
|  | 			WrappedErr:     err, | ||||||
|  | 			Caller:         "", | ||||||
|  | 			OriginalError:  nil, | ||||||
|  | 			Meta: MetaMap{ | ||||||
|  | 				"panic_object": {DataType: MDTString, Value: fmt.Sprintf("%+v", verr.RecoveredObj())}, | ||||||
|  | 				"panic_type":   {DataType: MDTString, Value: fmt.Sprintf("%T", verr.RecoveredObj())}, | ||||||
|  | 				"stack":        {DataType: MDTString, Value: verr.Stack}, | ||||||
|  | 			}, | ||||||
|  | 			Extra: make(map[string]any), | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	//goland:noinspection GoTypeAssertionOnErrors | ||||||
|  | 	if verr, ok := err.(*langext.PanicWrappedErr); ok && verr != nil { | ||||||
|  | 		return &ExErr{ | ||||||
|  | 			UniqueID:       newID(), | ||||||
|  | 			Category:       CatForeign, | ||||||
|  | 			Type:           TypePanic, | ||||||
|  | 			Severity:       SevErr, | ||||||
|  | 			Timestamp:      time.Time{}, | ||||||
|  | 			StatusCode:     nil, | ||||||
|  | 			Message:        "A panic occured", | ||||||
|  | 			WrappedErrType: fmt.Sprintf("%T", verr), | ||||||
|  | 			WrappedErr:     err, | ||||||
|  | 			Caller:         "", | ||||||
|  | 			OriginalError:  nil, | ||||||
|  | 			Meta: MetaMap{ | ||||||
|  | 				"panic_object": {DataType: MDTString, Value: fmt.Sprintf("%+v", verr.RecoveredObj())}, | ||||||
|  | 				"panic_type":   {DataType: MDTString, Value: fmt.Sprintf("%T", verr.RecoveredObj())}, | ||||||
|  | 				"stack":        {DataType: MDTString, Value: verr.Stack}, | ||||||
|  | 			}, | ||||||
|  | 			Extra: make(map[string]any), | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// A foreign error (eg a MongoDB exception) | ||||||
|  | 	return &ExErr{ | ||||||
|  | 		UniqueID:       newID(), | ||||||
|  | 		Category:       CatForeign, | ||||||
|  | 		Type:           TypeInternal, | ||||||
|  | 		Severity:       SevErr, | ||||||
|  | 		Timestamp:      time.Time{}, | ||||||
|  | 		StatusCode:     nil, | ||||||
|  | 		Message:        err.Error(), | ||||||
|  | 		WrappedErrType: fmt.Sprintf("%T", err), | ||||||
|  | 		WrappedErr:     err, | ||||||
|  | 		Caller:         "", | ||||||
|  | 		OriginalError:  nil, | ||||||
|  | 		Meta:           getForeignMeta(err), | ||||||
|  | 		Extra:          make(map[string]any), | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func newExErr(cat ErrorCategory, errtype ErrorType, msg string) *ExErr { | ||||||
|  | 	return &ExErr{ | ||||||
|  | 		UniqueID:       newID(), | ||||||
|  | 		Category:       cat, | ||||||
|  | 		Type:           errtype, | ||||||
|  | 		Severity:       SevErr, | ||||||
|  | 		Timestamp:      time.Now(), | ||||||
|  | 		StatusCode:     nil, | ||||||
|  | 		Message:        msg, | ||||||
|  | 		WrappedErrType: "", | ||||||
|  | 		WrappedErr:     nil, | ||||||
|  | 		Caller:         callername(2), | ||||||
|  | 		OriginalError:  nil, | ||||||
|  | 		Meta:           make(map[string]MetaValue), | ||||||
|  | 		Extra:          make(map[string]any), | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func wrapExErr(e *ExErr, msg string, cat ErrorCategory, stacktraceskip int) *ExErr { | ||||||
|  | 	return &ExErr{ | ||||||
|  | 		UniqueID:       newID(), | ||||||
|  | 		Category:       cat, | ||||||
|  | 		Type:           TypeWrap, | ||||||
|  | 		Severity:       e.Severity, | ||||||
|  | 		Timestamp:      time.Now(), | ||||||
|  | 		StatusCode:     e.StatusCode, | ||||||
|  | 		Message:        msg, | ||||||
|  | 		WrappedErrType: "", | ||||||
|  | 		WrappedErr:     nil, | ||||||
|  | 		Caller:         callername(1 + stacktraceskip), | ||||||
|  | 		OriginalError:  e, | ||||||
|  | 		Meta:           make(map[string]MetaValue), | ||||||
|  | 		Extra:          langext.CopyMap(langext.ForceMap(e.Extra)), | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func getForeignMeta(err error) (mm MetaMap) { | ||||||
|  | 	mm = make(map[string]MetaValue) | ||||||
|  |  | ||||||
|  | 	defer func() { | ||||||
|  | 		if panicerr := recover(); panicerr != nil { | ||||||
|  | 			New(TypePanic, "Panic while trying to get foreign meta"). | ||||||
|  | 				Str("source", err.Error()). | ||||||
|  | 				Interface("panic-object", panicerr). | ||||||
|  | 				Stack(). | ||||||
|  | 				Print() | ||||||
|  | 		} | ||||||
|  | 	}() | ||||||
|  |  | ||||||
|  | 	rval := reflect.ValueOf(err) | ||||||
|  | 	if rval.Kind() == reflect.Interface || rval.Kind() == reflect.Ptr { | ||||||
|  | 		rval = reflect.ValueOf(err).Elem() | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	mm.add("foreign.errortype", MDTString, rval.Type().String()) | ||||||
|  |  | ||||||
|  | 	for k, v := range addMetaPrefix("foreign", getReflectedMetaValues(err, 8)) { | ||||||
|  | 		mm[k] = v | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return mm | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func getReflectedMetaValues(value interface{}, remainingDepth int) map[string]MetaValue { | ||||||
|  |  | ||||||
|  | 	if remainingDepth <= 0 { | ||||||
|  | 		return map[string]MetaValue{} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if langext.IsNil(value) { | ||||||
|  | 		return map[string]MetaValue{"": {DataType: MDTNil, Value: nil}} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	rval := reflect.ValueOf(value) | ||||||
|  |  | ||||||
|  | 	if rval.Type().Kind() == reflect.Ptr { | ||||||
|  |  | ||||||
|  | 		if rval.IsNil() { | ||||||
|  | 			return map[string]MetaValue{"*": {DataType: MDTNil, Value: nil}} | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		elem := rval.Elem() | ||||||
|  |  | ||||||
|  | 		return addMetaPrefix("*", getReflectedMetaValues(elem.Interface(), remainingDepth-1)) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if !rval.CanInterface() { | ||||||
|  | 		return map[string]MetaValue{"": {DataType: MDTString, Value: "<<no-interface>>"}} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	raw := rval.Interface() | ||||||
|  |  | ||||||
|  | 	switch ifraw := raw.(type) { | ||||||
|  | 	case time.Time: | ||||||
|  | 		return map[string]MetaValue{"": {DataType: MDTTime, Value: ifraw}} | ||||||
|  | 	case time.Duration: | ||||||
|  | 		return map[string]MetaValue{"": {DataType: MDTDuration, Value: ifraw}} | ||||||
|  | 	case int: | ||||||
|  | 		return map[string]MetaValue{"": {DataType: MDTInt, Value: ifraw}} | ||||||
|  | 	case int8: | ||||||
|  | 		return map[string]MetaValue{"": {DataType: MDTInt8, Value: ifraw}} | ||||||
|  | 	case int16: | ||||||
|  | 		return map[string]MetaValue{"": {DataType: MDTInt16, Value: ifraw}} | ||||||
|  | 	case int32: | ||||||
|  | 		return map[string]MetaValue{"": {DataType: MDTInt32, Value: ifraw}} | ||||||
|  | 	case int64: | ||||||
|  | 		return map[string]MetaValue{"": {DataType: MDTInt64, Value: ifraw}} | ||||||
|  | 	case string: | ||||||
|  | 		return map[string]MetaValue{"": {DataType: MDTString, Value: ifraw}} | ||||||
|  | 	case bool: | ||||||
|  | 		return map[string]MetaValue{"": {DataType: MDTBool, Value: ifraw}} | ||||||
|  | 	case []byte: | ||||||
|  | 		return map[string]MetaValue{"": {DataType: MDTBytes, Value: ifraw}} | ||||||
|  | 	case float32: | ||||||
|  | 		return map[string]MetaValue{"": {DataType: MDTFloat32, Value: ifraw}} | ||||||
|  | 	case float64: | ||||||
|  | 		return map[string]MetaValue{"": {DataType: MDTFloat64, Value: ifraw}} | ||||||
|  | 	case []int: | ||||||
|  | 		return map[string]MetaValue{"": {DataType: MDTIntArray, Value: ifraw}} | ||||||
|  | 	case []int32: | ||||||
|  | 		return map[string]MetaValue{"": {DataType: MDTInt32Array, Value: ifraw}} | ||||||
|  | 	case primitive.ObjectID: | ||||||
|  | 		return map[string]MetaValue{"": {DataType: MDTObjectID, Value: ifraw}} | ||||||
|  | 	case []string: | ||||||
|  | 		return map[string]MetaValue{"": {DataType: MDTStringArray, Value: ifraw}} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if rval.Type().Kind() == reflect.Struct { | ||||||
|  | 		m := make(map[string]MetaValue) | ||||||
|  | 		for i := 0; i < rval.NumField(); i++ { | ||||||
|  | 			fieldtype := rval.Type().Field(i) | ||||||
|  |  | ||||||
|  | 			fieldname := fieldtype.Name | ||||||
|  |  | ||||||
|  | 			if fieldtype.IsExported() { | ||||||
|  | 				for k, v := range addMetaPrefix(fieldname, getReflectedMetaValues(rval.Field(i).Interface(), remainingDepth-1)) { | ||||||
|  | 					m[k] = v | ||||||
|  | 				} | ||||||
|  | 			} | ||||||
|  | 		} | ||||||
|  | 		return m | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if rval.Type().ConvertibleTo(reflectTypeStr) { | ||||||
|  | 		return map[string]MetaValue{"": {DataType: MDTString, Value: rval.Convert(reflectTypeStr).String()}} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	jsonval, err := json.Marshal(value) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return map[string]MetaValue{"": {DataType: MDTString, Value: fmt.Sprintf("Failed to Marshal %T:\n%+v", value, value)}} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return map[string]MetaValue{"": {DataType: MDTString, Value: string(jsonval)}} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func addMetaPrefix(prefix string, m map[string]MetaValue) map[string]MetaValue { | ||||||
|  | 	if len(m) == 1 { | ||||||
|  | 		for k, v := range m { | ||||||
|  | 			if k == "" { | ||||||
|  | 				return map[string]MetaValue{prefix: v} | ||||||
|  | 			} | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	r := make(map[string]MetaValue, len(m)) | ||||||
|  | 	for k, v := range m { | ||||||
|  | 		r[prefix+"."+k] = v | ||||||
|  | 	} | ||||||
|  | 	return r | ||||||
|  | } | ||||||
| @@ -1,32 +1,18 @@ | |||||||
| package exerr | package exerr | ||||||
|  |  | ||||||
| type ErrorCategory struct{ Category string } | type Method string | ||||||
|  |  | ||||||
| var ( | const ( | ||||||
| 	CatWrap    = ErrorCategory{"Wrap"}    // The error is simply wrapping another error (e.g. when a grpc call returns an error) | 	MethodOutput Method = "OUTPUT" | ||||||
| 	CatSystem  = ErrorCategory{"System"}  // An internal system error (e.g. connection to db failed) | 	MethodPrint  Method = "PRINT" | ||||||
| 	CatUser    = ErrorCategory{"User"}    // The user (the API caller) did something wrong (e.g. he has no permissions to do this) | 	MethodBuild  Method = "BUILD" | ||||||
| 	CatForeign = ErrorCategory{"Foreign"} // A foreign error that some component threw (e.g. an unknown mongodb error), happens if we call Wrap(..) on an non-bmerror value | 	MethodFatal  Method = "FATAL" | ||||||
| ) | ) | ||||||
|  |  | ||||||
| var AllCategories = []ErrorCategory{CatWrap, CatSystem, CatUser, CatForeign} | type LogPrintLevel string | ||||||
|  |  | ||||||
| type ErrorSeverity struct{ Severity string } | const ( | ||||||
|  | 	LogPrintFull     LogPrintLevel = "Full" | ||||||
| var ( | 	LogPrintOverview LogPrintLevel = "Overview" | ||||||
| 	SevTrace = ErrorSeverity{"Trace"} | 	LogPrintShort    LogPrintLevel = "Short" | ||||||
| 	SevDebug = ErrorSeverity{"Debug"} |  | ||||||
| 	SevInfo  = ErrorSeverity{"Info"} |  | ||||||
| 	SevWarn  = ErrorSeverity{"Warn"} |  | ||||||
| 	SevErr   = ErrorSeverity{"Err"} |  | ||||||
| 	SevFatal = ErrorSeverity{"Fatal"} |  | ||||||
| ) |  | ||||||
|  |  | ||||||
| var AllSeverities = []ErrorSeverity{SevTrace, SevDebug, SevInfo, SevWarn, SevErr, SevFatal} |  | ||||||
|  |  | ||||||
| type ErrorType struct{ Key string } |  | ||||||
|  |  | ||||||
| var ( |  | ||||||
| 	TypeInternal = ErrorType{"Internal"} |  | ||||||
| 	// other values come from pkgconfig |  | ||||||
| ) | ) | ||||||
|   | |||||||
							
								
								
									
										89
									
								
								exerr/dataCategory.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										89
									
								
								exerr/dataCategory.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,89 @@ | |||||||
|  | package exerr | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"encoding/json" | ||||||
|  | 	"errors" | ||||||
|  | 	"fmt" | ||||||
|  | 	"go.mongodb.org/mongo-driver/bson" | ||||||
|  | 	"go.mongodb.org/mongo-driver/bson/bsoncodec" | ||||||
|  | 	"go.mongodb.org/mongo-driver/bson/bsonrw" | ||||||
|  | 	"go.mongodb.org/mongo-driver/bson/bsontype" | ||||||
|  | 	"reflect" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | type ErrorCategory struct{ Category string } | ||||||
|  |  | ||||||
|  | var ( | ||||||
|  | 	CatWrap    = ErrorCategory{"Wrap"}    // The error is simply wrapping another error (e.g. when a grpc call returns an error) | ||||||
|  | 	CatSystem  = ErrorCategory{"System"}  // An internal system error (e.g. connection to db failed) | ||||||
|  | 	CatUser    = ErrorCategory{"User"}    // The user (the API caller) did something wrong (e.g. he has no permissions to do this) | ||||||
|  | 	CatForeign = ErrorCategory{"Foreign"} // A foreign error that some component threw (e.g. an unknown mongodb error), happens if we call Wrap(..) on an non-bmerror value | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | func (e *ErrorCategory) UnmarshalJSON(bytes []byte) error { | ||||||
|  | 	return json.Unmarshal(bytes, &e.Category) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (e ErrorCategory) MarshalJSON() ([]byte, error) { | ||||||
|  | 	return json.Marshal(e.Category) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (e *ErrorCategory) UnmarshalBSONValue(bt bsontype.Type, data []byte) error { | ||||||
|  | 	if bt == bson.TypeNull { | ||||||
|  | 		// we can't set nil in UnmarshalBSONValue (so we use default(struct)) | ||||||
|  | 		// Use mongoext.CreateGoExtBsonRegistry if you need to unmarsh pointer values | ||||||
|  | 		// https://stackoverflow.com/questions/75167597 | ||||||
|  | 		// https://jira.mongodb.org/browse/GODRIVER-2252 | ||||||
|  | 		*e = ErrorCategory{} | ||||||
|  | 		return nil | ||||||
|  | 	} | ||||||
|  | 	if bt != bson.TypeString { | ||||||
|  | 		return errors.New(fmt.Sprintf("cannot unmarshal %v into String", bt)) | ||||||
|  | 	} | ||||||
|  | 	var tt string | ||||||
|  | 	err := bson.RawValue{Type: bt, Value: data}.Unmarshal(&tt) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return err | ||||||
|  | 	} | ||||||
|  | 	*e = ErrorCategory{tt} | ||||||
|  | 	return nil | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (e ErrorCategory) MarshalBSONValue() (bsontype.Type, []byte, error) { | ||||||
|  | 	return bson.MarshalValue(e.Category) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (e ErrorCategory) DecodeValue(dc bsoncodec.DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error { | ||||||
|  | 	if val.Kind() == reflect.Ptr && val.IsNil() { | ||||||
|  | 		if !val.CanSet() { | ||||||
|  | 			return errors.New("ValueUnmarshalerDecodeValue") | ||||||
|  | 		} | ||||||
|  | 		val.Set(reflect.New(val.Type().Elem())) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	tp, src, err := bsonrw.Copier{}.CopyValueToBytes(vr) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if val.Kind() == reflect.Ptr && len(src) == 0 { | ||||||
|  | 		val.Set(reflect.Zero(val.Type())) | ||||||
|  | 		return nil | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	err = e.UnmarshalBSONValue(tp, src) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if val.Kind() == reflect.Ptr { | ||||||
|  | 		val.Set(reflect.ValueOf(&e)) | ||||||
|  | 	} else { | ||||||
|  | 		val.Set(reflect.ValueOf(e)) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return nil | ||||||
|  | } | ||||||
|  |  | ||||||
|  | //goland:noinspection GoUnusedGlobalVariable | ||||||
|  | var AllCategories = []ErrorCategory{CatWrap, CatSystem, CatUser, CatForeign} | ||||||
							
								
								
									
										91
									
								
								exerr/dataSeverity.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										91
									
								
								exerr/dataSeverity.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,91 @@ | |||||||
|  | package exerr | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"encoding/json" | ||||||
|  | 	"errors" | ||||||
|  | 	"fmt" | ||||||
|  | 	"go.mongodb.org/mongo-driver/bson" | ||||||
|  | 	"go.mongodb.org/mongo-driver/bson/bsoncodec" | ||||||
|  | 	"go.mongodb.org/mongo-driver/bson/bsonrw" | ||||||
|  | 	"go.mongodb.org/mongo-driver/bson/bsontype" | ||||||
|  | 	"reflect" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | type ErrorSeverity struct{ Severity string } | ||||||
|  |  | ||||||
|  | var ( | ||||||
|  | 	SevTrace = ErrorSeverity{"Trace"} | ||||||
|  | 	SevDebug = ErrorSeverity{"Debug"} | ||||||
|  | 	SevInfo  = ErrorSeverity{"Info"} | ||||||
|  | 	SevWarn  = ErrorSeverity{"Warn"} | ||||||
|  | 	SevErr   = ErrorSeverity{"Err"} | ||||||
|  | 	SevFatal = ErrorSeverity{"Fatal"} | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | func (e *ErrorSeverity) UnmarshalJSON(bytes []byte) error { | ||||||
|  | 	return json.Unmarshal(bytes, &e.Severity) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (e ErrorSeverity) MarshalJSON() ([]byte, error) { | ||||||
|  | 	return json.Marshal(e.Severity) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (e *ErrorSeverity) UnmarshalBSONValue(bt bsontype.Type, data []byte) error { | ||||||
|  | 	if bt == bson.TypeNull { | ||||||
|  | 		// we can't set nil in UnmarshalBSONValue (so we use default(struct)) | ||||||
|  | 		// Use mongoext.CreateGoExtBsonRegistry if you need to unmarsh pointer values | ||||||
|  | 		// https://stackoverflow.com/questions/75167597 | ||||||
|  | 		// https://jira.mongodb.org/browse/GODRIVER-2252 | ||||||
|  | 		*e = ErrorSeverity{} | ||||||
|  | 		return nil | ||||||
|  | 	} | ||||||
|  | 	if bt != bson.TypeString { | ||||||
|  | 		return errors.New(fmt.Sprintf("cannot unmarshal %v into String", bt)) | ||||||
|  | 	} | ||||||
|  | 	var tt string | ||||||
|  | 	err := bson.RawValue{Type: bt, Value: data}.Unmarshal(&tt) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return err | ||||||
|  | 	} | ||||||
|  | 	*e = ErrorSeverity{tt} | ||||||
|  | 	return nil | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (e ErrorSeverity) MarshalBSONValue() (bsontype.Type, []byte, error) { | ||||||
|  | 	return bson.MarshalValue(e.Severity) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (e ErrorSeverity) DecodeValue(dc bsoncodec.DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error { | ||||||
|  | 	if val.Kind() == reflect.Ptr && val.IsNil() { | ||||||
|  | 		if !val.CanSet() { | ||||||
|  | 			return errors.New("ValueUnmarshalerDecodeValue") | ||||||
|  | 		} | ||||||
|  | 		val.Set(reflect.New(val.Type().Elem())) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	tp, src, err := bsonrw.Copier{}.CopyValueToBytes(vr) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if val.Kind() == reflect.Ptr && len(src) == 0 { | ||||||
|  | 		val.Set(reflect.Zero(val.Type())) | ||||||
|  | 		return nil | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	err = e.UnmarshalBSONValue(tp, src) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if val.Kind() == reflect.Ptr { | ||||||
|  | 		val.Set(reflect.ValueOf(&e)) | ||||||
|  | 	} else { | ||||||
|  | 		val.Set(reflect.ValueOf(e)) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return nil | ||||||
|  | } | ||||||
|  |  | ||||||
|  | //goland:noinspection GoUnusedGlobalVariable | ||||||
|  | var AllSeverities = []ErrorSeverity{SevTrace, SevDebug, SevInfo, SevWarn, SevErr, SevFatal} | ||||||
							
								
								
									
										156
									
								
								exerr/dataType.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										156
									
								
								exerr/dataType.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,156 @@ | |||||||
|  | package exerr | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"encoding/json" | ||||||
|  | 	"errors" | ||||||
|  | 	"fmt" | ||||||
|  | 	"go.mongodb.org/mongo-driver/bson" | ||||||
|  | 	"go.mongodb.org/mongo-driver/bson/bsoncodec" | ||||||
|  | 	"go.mongodb.org/mongo-driver/bson/bsonrw" | ||||||
|  | 	"go.mongodb.org/mongo-driver/bson/bsontype" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/dataext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | 	"reflect" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | type ErrorType struct { | ||||||
|  | 	Key               string | ||||||
|  | 	DefaultStatusCode *int | ||||||
|  | } | ||||||
|  |  | ||||||
|  | //goland:noinspection GoUnusedGlobalVariable | ||||||
|  | var ( | ||||||
|  | 	TypeInternal       = NewType("INTERNAL_ERROR", langext.Ptr(500)) | ||||||
|  | 	TypePanic          = NewType("PANIC", langext.Ptr(500)) | ||||||
|  | 	TypeNotImplemented = NewType("NOT_IMPLEMENTED", langext.Ptr(500)) | ||||||
|  | 	TypeAssert         = NewType("ASSERT", langext.Ptr(500)) | ||||||
|  |  | ||||||
|  | 	TypeMongoQuery        = NewType("MONGO_QUERY", langext.Ptr(500)) | ||||||
|  | 	TypeCursorTokenDecode = NewType("CURSOR_TOKEN_DECODE", langext.Ptr(500)) | ||||||
|  | 	TypeMongoFilter       = NewType("MONGO_FILTER", langext.Ptr(500)) | ||||||
|  | 	TypeMongoReflection   = NewType("MONGO_REFLECTION", langext.Ptr(500)) | ||||||
|  | 	TypeMongoInvalidOpt   = NewType("MONGO_INVALIDOPT", langext.Ptr(500)) | ||||||
|  |  | ||||||
|  | 	TypeSQLQuery  = NewType("SQL_QUERY", langext.Ptr(500)) | ||||||
|  | 	TypeSQLBuild  = NewType("SQL_BUILD", langext.Ptr(500)) | ||||||
|  | 	TypeSQLDecode = NewType("SQL_DECODE", langext.Ptr(500)) | ||||||
|  |  | ||||||
|  | 	TypeWrap = NewType("Wrap", nil) | ||||||
|  |  | ||||||
|  | 	TypeBindFailURI      = NewType("BINDFAIL_URI", langext.Ptr(400)) | ||||||
|  | 	TypeBindFailQuery    = NewType("BINDFAIL_QUERY", langext.Ptr(400)) | ||||||
|  | 	TypeBindFailJSON     = NewType("BINDFAIL_JSON", langext.Ptr(400)) | ||||||
|  | 	TypeBindFailFormData = NewType("BINDFAIL_FORMDATA", langext.Ptr(400)) | ||||||
|  | 	TypeBindFailHeader   = NewType("BINDFAIL_HEADER", langext.Ptr(400)) | ||||||
|  |  | ||||||
|  | 	TypeMarshalEntityID = NewType("MARSHAL_ENTITY_ID", langext.Ptr(400)) | ||||||
|  | 	TypeInvalidCSID     = NewType("INVALID_CSID", langext.Ptr(400)) | ||||||
|  |  | ||||||
|  | 	TypeGoogleStatuscode = NewType("GOOGLE_STATUSCODE", langext.Ptr(400)) | ||||||
|  | 	TypeGoogleResponse   = NewType("GOOGLE_RESPONSE", langext.Ptr(400)) | ||||||
|  |  | ||||||
|  | 	TypeUnauthorized = NewType("UNAUTHORIZED", langext.Ptr(401)) | ||||||
|  | 	TypeAuthFailed   = NewType("AUTH_FAILED", langext.Ptr(401)) | ||||||
|  |  | ||||||
|  | 	TypeInvalidImage    = NewType("IMAGEEXT_INVALID_IMAGE", langext.Ptr(400)) | ||||||
|  | 	TypeInvalidMimeType = NewType("IMAGEEXT_INVALID_MIMETYPE", langext.Ptr(400)) | ||||||
|  |  | ||||||
|  | 	// other values come from the downstream application that uses goext | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | func (e *ErrorType) UnmarshalJSON(bytes []byte) error { | ||||||
|  | 	var k string | ||||||
|  | 	err := json.Unmarshal(bytes, &k) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if d, ok := registeredTypes.Get(k); ok { | ||||||
|  | 		*e = d | ||||||
|  | 		return nil | ||||||
|  | 	} else { | ||||||
|  | 		*e = ErrorType{k, nil} | ||||||
|  | 		return nil | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (e ErrorType) MarshalJSON() ([]byte, error) { | ||||||
|  | 	return json.Marshal(e.Key) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (e *ErrorType) UnmarshalBSONValue(bt bsontype.Type, data []byte) error { | ||||||
|  | 	if bt == bson.TypeNull { | ||||||
|  | 		// we can't set nil in UnmarshalBSONValue (so we use default(struct)) | ||||||
|  | 		// Use mongoext.CreateGoExtBsonRegistry if you need to unmarsh pointer values | ||||||
|  | 		// https://stackoverflow.com/questions/75167597 | ||||||
|  | 		// https://jira.mongodb.org/browse/GODRIVER-2252 | ||||||
|  | 		*e = ErrorType{} | ||||||
|  | 		return nil | ||||||
|  | 	} | ||||||
|  | 	if bt != bson.TypeString { | ||||||
|  | 		return errors.New(fmt.Sprintf("cannot unmarshal %v into String", bt)) | ||||||
|  | 	} | ||||||
|  | 	var tt string | ||||||
|  | 	err := bson.RawValue{Type: bt, Value: data}.Unmarshal(&tt) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if d, ok := registeredTypes.Get(tt); ok { | ||||||
|  | 		*e = d | ||||||
|  | 		return nil | ||||||
|  | 	} else { | ||||||
|  | 		*e = ErrorType{tt, nil} | ||||||
|  | 		return nil | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (e ErrorType) MarshalBSONValue() (bsontype.Type, []byte, error) { | ||||||
|  | 	return bson.MarshalValue(e.Key) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (e ErrorType) DecodeValue(dc bsoncodec.DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error { | ||||||
|  | 	if val.Kind() == reflect.Ptr && val.IsNil() { | ||||||
|  | 		if !val.CanSet() { | ||||||
|  | 			return errors.New("ValueUnmarshalerDecodeValue") | ||||||
|  | 		} | ||||||
|  | 		val.Set(reflect.New(val.Type().Elem())) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	tp, src, err := bsonrw.Copier{}.CopyValueToBytes(vr) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if val.Kind() == reflect.Ptr && len(src) == 0 { | ||||||
|  | 		val.Set(reflect.Zero(val.Type())) | ||||||
|  | 		return nil | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	err = e.UnmarshalBSONValue(tp, src) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if val.Kind() == reflect.Ptr { | ||||||
|  | 		val.Set(reflect.ValueOf(&e)) | ||||||
|  | 	} else { | ||||||
|  | 		val.Set(reflect.ValueOf(e)) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return nil | ||||||
|  | } | ||||||
|  |  | ||||||
|  | var registeredTypes = dataext.SyncMap[string, ErrorType]{} | ||||||
|  |  | ||||||
|  | func NewType(key string, defStatusCode *int) ErrorType { | ||||||
|  | 	et := ErrorType{key, defStatusCode} | ||||||
|  |  | ||||||
|  | 	registeredTypes.Set(key, et) | ||||||
|  |  | ||||||
|  | 	return et | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func ListRegisteredTypes() []ErrorType { | ||||||
|  | 	return registeredTypes.GetAllValues() | ||||||
|  | } | ||||||
							
								
								
									
										153
									
								
								exerr/data_test.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										153
									
								
								exerr/data_test.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,153 @@ | |||||||
|  | package exerr | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"context" | ||||||
|  | 	"encoding/json" | ||||||
|  | 	"go.mongodb.org/mongo-driver/bson" | ||||||
|  | 	"go.mongodb.org/mongo-driver/bson/primitive" | ||||||
|  | 	"go.mongodb.org/mongo-driver/mongo" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/tst" | ||||||
|  | 	"testing" | ||||||
|  | 	"time" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | func TestJSONMarshalErrorCategory(t *testing.T) { | ||||||
|  |  | ||||||
|  | 	c1 := CatSystem | ||||||
|  |  | ||||||
|  | 	jsonbin := tst.Must(json.Marshal(c1))(t) | ||||||
|  |  | ||||||
|  | 	var c2 ErrorCategory | ||||||
|  | 	tst.AssertNoErr(t, json.Unmarshal(jsonbin, &c2)) | ||||||
|  |  | ||||||
|  | 	tst.AssertEqual(t, c1, c2) | ||||||
|  |  | ||||||
|  | 	tst.AssertEqual(t, string(jsonbin), "\"System\"") | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestJSONMarshalErrorSeverity(t *testing.T) { | ||||||
|  |  | ||||||
|  | 	c1 := SevErr | ||||||
|  |  | ||||||
|  | 	jsonbin := tst.Must(json.Marshal(c1))(t) | ||||||
|  |  | ||||||
|  | 	var c2 ErrorSeverity | ||||||
|  | 	tst.AssertNoErr(t, json.Unmarshal(jsonbin, &c2)) | ||||||
|  |  | ||||||
|  | 	tst.AssertEqual(t, c1, c2) | ||||||
|  |  | ||||||
|  | 	tst.AssertEqual(t, string(jsonbin), "\"Err\"") | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestJSONMarshalErrorType(t *testing.T) { | ||||||
|  |  | ||||||
|  | 	c1 := TypeNotImplemented | ||||||
|  |  | ||||||
|  | 	jsonbin := tst.Must(json.Marshal(c1))(t) | ||||||
|  |  | ||||||
|  | 	var c2 ErrorType | ||||||
|  | 	tst.AssertNoErr(t, json.Unmarshal(jsonbin, &c2)) | ||||||
|  |  | ||||||
|  | 	tst.AssertEqual(t, c1, c2) | ||||||
|  |  | ||||||
|  | 	tst.AssertEqual(t, string(jsonbin), "\"NOT_IMPLEMENTED\"") | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestBSONMarshalErrorCategory(t *testing.T) { | ||||||
|  | 	ctx, cancel := context.WithTimeout(context.Background(), 350*time.Millisecond) | ||||||
|  | 	defer cancel() | ||||||
|  |  | ||||||
|  | 	client, err := mongo.Connect(ctx) | ||||||
|  | 	if err != nil { | ||||||
|  | 		t.Skip("Skip test - no local mongo found") | ||||||
|  | 		return | ||||||
|  | 	} | ||||||
|  | 	err = client.Ping(ctx, nil) | ||||||
|  | 	if err != nil { | ||||||
|  | 		t.Skip("Skip test - no local mongo found") | ||||||
|  | 		return | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	primimd := primitive.NewObjectID() | ||||||
|  |  | ||||||
|  | 	_, err = client.Database("_test").Collection("goext-cicd").InsertOne(ctx, bson.M{"_id": primimd, "val": CatSystem}) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	cursor := client.Database("_test").Collection("goext-cicd").FindOne(ctx, bson.M{"_id": primimd, "val": bson.M{"$type": "string"}}) | ||||||
|  |  | ||||||
|  | 	var c1 struct { | ||||||
|  | 		ID  primitive.ObjectID `bson:"_id"` | ||||||
|  | 		Val ErrorCategory      `bson:"val"` | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	err = cursor.Decode(&c1) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	tst.AssertEqual(t, c1.Val, CatSystem) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestBSONMarshalErrorSeverity(t *testing.T) { | ||||||
|  | 	ctx, cancel := context.WithTimeout(context.Background(), 350*time.Millisecond) | ||||||
|  | 	defer cancel() | ||||||
|  |  | ||||||
|  | 	client, err := mongo.Connect(ctx) | ||||||
|  | 	if err != nil { | ||||||
|  | 		t.Skip("Skip test - no local mongo found") | ||||||
|  | 		return | ||||||
|  | 	} | ||||||
|  | 	err = client.Ping(ctx, nil) | ||||||
|  | 	if err != nil { | ||||||
|  | 		t.Skip("Skip test - no local mongo found") | ||||||
|  | 		return | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	primimd := primitive.NewObjectID() | ||||||
|  |  | ||||||
|  | 	_, err = client.Database("_test").Collection("goext-cicd").InsertOne(ctx, bson.M{"_id": primimd, "val": SevErr}) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	cursor := client.Database("_test").Collection("goext-cicd").FindOne(ctx, bson.M{"_id": primimd, "val": bson.M{"$type": "string"}}) | ||||||
|  |  | ||||||
|  | 	var c1 struct { | ||||||
|  | 		ID  primitive.ObjectID `bson:"_id"` | ||||||
|  | 		Val ErrorSeverity      `bson:"val"` | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	err = cursor.Decode(&c1) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	tst.AssertEqual(t, c1.Val, SevErr) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestBSONMarshalErrorType(t *testing.T) { | ||||||
|  | 	ctx, cancel := context.WithTimeout(context.Background(), 350*time.Millisecond) | ||||||
|  | 	defer cancel() | ||||||
|  |  | ||||||
|  | 	client, err := mongo.Connect(ctx) | ||||||
|  | 	if err != nil { | ||||||
|  | 		t.Skip("Skip test - no local mongo found") | ||||||
|  | 		return | ||||||
|  | 	} | ||||||
|  | 	err = client.Ping(ctx, nil) | ||||||
|  | 	if err != nil { | ||||||
|  | 		t.Skip("Skip test - no local mongo found") | ||||||
|  | 		return | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	primimd := primitive.NewObjectID() | ||||||
|  |  | ||||||
|  | 	_, err = client.Database("_test").Collection("goext-cicd").InsertOne(ctx, bson.M{"_id": primimd, "val": TypeNotImplemented}) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	cursor := client.Database("_test").Collection("goext-cicd").FindOne(ctx, bson.M{"_id": primimd, "val": bson.M{"$type": "string"}}) | ||||||
|  |  | ||||||
|  | 	var c1 struct { | ||||||
|  | 		ID  primitive.ObjectID `bson:"_id"` | ||||||
|  | 		Val ErrorType          `bson:"val"` | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	err = cursor.Decode(&c1) | ||||||
|  | 	tst.AssertNoErr(t, err) | ||||||
|  |  | ||||||
|  | 	tst.AssertEqual(t, c1.Val, TypeNotImplemented) | ||||||
|  | } | ||||||
| @@ -1 +0,0 @@ | |||||||
| package exerr |  | ||||||
							
								
								
									
										126
									
								
								exerr/errinit.go
									
									
									
									
									
								
							
							
						
						
									
										126
									
								
								exerr/errinit.go
									
									
									
									
									
								
							| @@ -1,23 +1,62 @@ | |||||||
| package exerr | package exerr | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"context" | ||||||
|  | 	"fmt" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | 	"github.com/gin-gonic/gin" | ||||||
|  | 	"github.com/rs/zerolog" | ||||||
|  | 	"net/http" | ||||||
|  | 	"os" | ||||||
|  | ) | ||||||
|  |  | ||||||
| type ErrorPackageConfig struct { | type ErrorPackageConfig struct { | ||||||
| 	ZeroLogTraces   bool        // autom print zerolog logs on CreateError | 	ZeroLogErrTraces       bool                                                                     // autom print zerolog logs on .Build()  (for SevErr and SevFatal) | ||||||
| 	RecursiveErrors bool        // errors contains their Origin-Error | 	ZeroLogAllTraces       bool                                                                     // autom print zerolog logs on .Build()  (for all Severities) | ||||||
| 	Types           []ErrorType // all available error-types | 	RecursiveErrors        bool                                                                     // errors contains their Origin-Error | ||||||
|  | 	ExtendedGinOutput      bool                                                                     // Log extended data (trace, meta, ...) to gin in err.Output() | ||||||
|  | 	IncludeMetaInGinOutput bool                                                                     // Log meta fields ( from e.g. `.Str(key, val).Build()` ) to gin in err.Output() | ||||||
|  | 	ExtendGinOutput        func(err *ExErr, json map[string]any)                                    // (Optionally) extend the gin output with more fields | ||||||
|  | 	ExtendGinDataOutput    func(err *ExErr, depth int, json map[string]any)                         // (Optionally) extend the gin `__data` output with more fields | ||||||
|  | 	DisableErrorWrapping   bool                                                                     // Disables the exerr.Wrap()...Build() function - will always return the original error | ||||||
|  | 	ZeroLogErrGinOutput    bool                                                                     // autom print zerolog logs on ginext.Error() / .Output(gin)  (for SevErr and SevFatal) | ||||||
|  | 	ZeroLogAllGinOutput    bool                                                                     // autom print zerolog logs on ginext.Error() / .Output(gin)  (for all Severities) | ||||||
|  | 	ExtendGinMeta          func(ctx context.Context, b *Builder, g *gin.Context, req *http.Request) // (Optionally) extend the final error meta values with additional data from the gin context (a few are automatically added, here more can be included) | ||||||
|  | 	ExtendContextMeta      func(b *Builder, method Method, dctx context.Context)                    // (Optionally) extend the final error meta values with additional data from the context (a few are automatically added, here more can be included) | ||||||
|  | 	ZeroLogger             zerolog.Logger                                                           // The logger used to print exerr log messages | ||||||
| } | } | ||||||
|  |  | ||||||
| type ErrorPackageConfigInit struct { | type ErrorPackageConfigInit struct { | ||||||
| 	LogTraces       bool | 	ZeroLogErrTraces       *bool | ||||||
| 	RecursiveErrors bool | 	ZeroLogAllTraces       *bool | ||||||
| 	InitTypes       func(_ func(_ string) ErrorType) | 	RecursiveErrors        *bool | ||||||
|  | 	ExtendedGinOutput      *bool | ||||||
|  | 	IncludeMetaInGinOutput *bool | ||||||
|  | 	ExtendGinOutput        func(err *ExErr, json map[string]any) | ||||||
|  | 	ExtendGinDataOutput    func(err *ExErr, depth int, json map[string]any) | ||||||
|  | 	DisableErrorWrapping   *bool | ||||||
|  | 	ZeroLogErrGinOutput    *bool | ||||||
|  | 	ZeroLogAllGinOutput    *bool | ||||||
|  | 	ExtendGinMeta          func(ctx context.Context, b *Builder, g *gin.Context, req *http.Request) | ||||||
|  | 	ExtendContextMeta      func(b *Builder, method Method, dctx context.Context) | ||||||
|  | 	ZeroLogger             *zerolog.Logger | ||||||
| } | } | ||||||
|  |  | ||||||
| var initialized = false | var initialized = false | ||||||
|  |  | ||||||
| var pkgconfig = ErrorPackageConfig{ | var pkgconfig = ErrorPackageConfig{ | ||||||
| 	ZeroLogTraces:   true, | 	ZeroLogErrTraces:       true, | ||||||
| 	RecursiveErrors: true, | 	ZeroLogAllTraces:       false, | ||||||
| 	Types:           []ErrorType{TypeInternal}, | 	RecursiveErrors:        true, | ||||||
|  | 	ExtendedGinOutput:      false, | ||||||
|  | 	IncludeMetaInGinOutput: true, | ||||||
|  | 	ExtendGinOutput:        func(err *ExErr, json map[string]any) {}, | ||||||
|  | 	ExtendGinDataOutput:    func(err *ExErr, depth int, json map[string]any) {}, | ||||||
|  | 	DisableErrorWrapping:   false, | ||||||
|  | 	ZeroLogErrGinOutput:    true, | ||||||
|  | 	ZeroLogAllGinOutput:    false, | ||||||
|  | 	ExtendGinMeta:          func(ctx context.Context, b *Builder, g *gin.Context, req *http.Request) {}, | ||||||
|  | 	ExtendContextMeta:      func(b *Builder, method Method, dctx context.Context) {}, | ||||||
| } | } | ||||||
|  |  | ||||||
| // Init initializes the exerr packages | // Init initializes the exerr packages | ||||||
| @@ -28,23 +67,72 @@ func Init(cfg ErrorPackageConfigInit) { | |||||||
| 		panic("Cannot re-init error package") | 		panic("Cannot re-init error package") | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	types := pkgconfig.Types | 	ego := func(err *ExErr, json map[string]any) {} | ||||||
|  | 	egdo := func(err *ExErr, depth int, json map[string]any) {} | ||||||
|  | 	egm := func(ctx context.Context, b *Builder, g *gin.Context, req *http.Request) {} | ||||||
|  | 	egcm := func(b *Builder, method Method, dctx context.Context) {} | ||||||
|  |  | ||||||
| 	fnAddType := func(v string) ErrorType { | 	if cfg.ExtendGinOutput != nil { | ||||||
| 		et := ErrorType{v} | 		ego = cfg.ExtendGinOutput | ||||||
| 		types = append(types, et) | 	} | ||||||
| 		return et | 	if cfg.ExtendGinDataOutput != nil { | ||||||
|  | 		egdo = cfg.ExtendGinDataOutput | ||||||
|  | 	} | ||||||
|  | 	if cfg.ExtendGinMeta != nil { | ||||||
|  | 		egm = cfg.ExtendGinMeta | ||||||
|  | 	} | ||||||
|  | 	if cfg.ExtendContextMeta != nil { | ||||||
|  | 		egcm = cfg.ExtendContextMeta | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	if cfg.InitTypes != nil { | 	var logger zerolog.Logger | ||||||
| 		cfg.InitTypes(fnAddType) | 	if cfg.ZeroLogger != nil { | ||||||
|  | 		logger = *cfg.ZeroLogger | ||||||
|  | 	} else { | ||||||
|  | 		logger = newDefaultLogger() | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	pkgconfig = ErrorPackageConfig{ | 	pkgconfig = ErrorPackageConfig{ | ||||||
| 		ZeroLogTraces:   cfg.LogTraces, | 		ZeroLogErrTraces:       langext.Coalesce(cfg.ZeroLogErrTraces, pkgconfig.ZeroLogErrTraces), | ||||||
| 		RecursiveErrors: cfg.RecursiveErrors, | 		ZeroLogAllTraces:       langext.Coalesce(cfg.ZeroLogAllTraces, pkgconfig.ZeroLogAllTraces), | ||||||
| 		Types:           types, | 		RecursiveErrors:        langext.Coalesce(cfg.RecursiveErrors, pkgconfig.RecursiveErrors), | ||||||
|  | 		ExtendedGinOutput:      langext.Coalesce(cfg.ExtendedGinOutput, pkgconfig.ExtendedGinOutput), | ||||||
|  | 		IncludeMetaInGinOutput: langext.Coalesce(cfg.IncludeMetaInGinOutput, pkgconfig.IncludeMetaInGinOutput), | ||||||
|  | 		ExtendGinOutput:        ego, | ||||||
|  | 		ExtendGinDataOutput:    egdo, | ||||||
|  | 		DisableErrorWrapping:   langext.Coalesce(cfg.DisableErrorWrapping, pkgconfig.DisableErrorWrapping), | ||||||
|  | 		ZeroLogAllGinOutput:    langext.Coalesce(cfg.ZeroLogAllGinOutput, pkgconfig.ZeroLogAllGinOutput), | ||||||
|  | 		ZeroLogErrGinOutput:    langext.Coalesce(cfg.ZeroLogErrGinOutput, pkgconfig.ZeroLogErrGinOutput), | ||||||
|  | 		ExtendGinMeta:          egm, | ||||||
|  | 		ExtendContextMeta:      egcm, | ||||||
|  | 		ZeroLogger:             logger, | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	initialized = true | 	initialized = true | ||||||
| } | } | ||||||
|  |  | ||||||
|  | func newDefaultLogger() zerolog.Logger { | ||||||
|  | 	cw := zerolog.ConsoleWriter{ | ||||||
|  | 		Out:        os.Stdout, | ||||||
|  | 		TimeFormat: "2006-01-02 15:04:05 Z07:00", | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	multi := zerolog.MultiLevelWriter(cw) | ||||||
|  |  | ||||||
|  | 	return zerolog.New(multi).With().Timestamp().CallerWithSkipFrameCount(5).Logger() | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func Initialized() bool { | ||||||
|  | 	return initialized | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func warnOnPkgConfigNotInitialized() { | ||||||
|  | 	if !initialized { | ||||||
|  | 		fmt.Printf("\n") | ||||||
|  | 		fmt.Printf("%s\n", langext.StrRepeat("=", 80)) | ||||||
|  | 		fmt.Printf("%s\n", "[WARNING] exerr package used without initializiation") | ||||||
|  | 		fmt.Printf("%s\n", "          call exerr.Init() in your main() function") | ||||||
|  | 		fmt.Printf("%s\n", langext.StrRepeat("=", 80)) | ||||||
|  | 		fmt.Printf("\n") | ||||||
|  | 	} | ||||||
|  | } | ||||||
|   | |||||||
							
								
								
									
										421
									
								
								exerr/exerr.go
									
									
									
									
									
								
							
							
						
						
									
										421
									
								
								exerr/exerr.go
									
									
									
									
									
								
							| @@ -1,6 +1,12 @@ | |||||||
| package exerr | package exerr | ||||||
|  |  | ||||||
| import ( | import ( | ||||||
|  | 	"fmt" | ||||||
|  | 	"github.com/rs/xid" | ||||||
|  | 	"github.com/rs/zerolog" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | 	"reflect" | ||||||
|  | 	"strings" | ||||||
| 	"time" | 	"time" | ||||||
| ) | ) | ||||||
|  |  | ||||||
| @@ -12,22 +18,419 @@ type ExErr struct { | |||||||
| 	Severity  ErrorSeverity `json:"severity"` | 	Severity  ErrorSeverity `json:"severity"` | ||||||
| 	Type      ErrorType     `json:"type"` | 	Type      ErrorType     `json:"type"` | ||||||
|  |  | ||||||
| 	Message string `json:"message"` | 	StatusCode *int `json:"statusCode"` | ||||||
| 	Caller  string `json:"caller"` |  | ||||||
|  |  | ||||||
| 	OriginalError *ExErr | 	Message        string `json:"message"` | ||||||
|  | 	WrappedErrType string `json:"wrappedErrType"` | ||||||
|  | 	WrappedErr     any    `json:"-"` | ||||||
|  | 	Caller         string `json:"caller"` | ||||||
|  |  | ||||||
| 	Meta MetaMap `json:"meta"` | 	OriginalError *ExErr `json:"originalError"` | ||||||
|  |  | ||||||
|  | 	Extra map[string]any `json:"extra"` | ||||||
|  | 	Meta  MetaMap        `json:"meta"` | ||||||
| } | } | ||||||
|  |  | ||||||
| func (ee ExErr) Error() string { | func (ee *ExErr) Error() string { | ||||||
|  | 	return ee.RecursiveMessage() | ||||||
| } | } | ||||||
|  |  | ||||||
| func (ee ExErr) Unwrap() error { | // Unwrap must be implemented so that some error.XXX methods work | ||||||
|  | func (ee *ExErr) Unwrap() error { | ||||||
|  | 	if ee.OriginalError == nil { | ||||||
|  |  | ||||||
|  | 		if ee.WrappedErr != nil { | ||||||
|  | 			if werr, ok := ee.WrappedErr.(error); ok { | ||||||
|  | 				return werr | ||||||
|  | 			} | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		return nil // this is neccessary - otherwise we return a wrapped nil and the `x == nil` comparison fails (= panic in errors.Is and other failures) | ||||||
|  | 	} | ||||||
|  | 	return ee.OriginalError | ||||||
| } | } | ||||||
|  |  | ||||||
| func (ee ExErr) Is(err error) bool { | // Is must be implemented so that error.Is(x) works | ||||||
|  | func (ee *ExErr) Is(e error) bool { | ||||||
|  | 	return IsFrom(ee, e) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // As must be implemented so that error.As(x) works | ||||||
|  | // | ||||||
|  | //goland:noinspection GoTypeAssertionOnErrors | ||||||
|  | func (ee *ExErr) As(target any) bool { | ||||||
|  | 	if dstErr, ok := target.(*ExErr); ok { | ||||||
|  |  | ||||||
|  | 		if dst0, ok := ee.contains(dstErr); ok { | ||||||
|  | 			dstErr = dst0 | ||||||
|  | 			return true | ||||||
|  | 		} else { | ||||||
|  | 			return false | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 	} else { | ||||||
|  |  | ||||||
|  | 		val := reflect.ValueOf(target) | ||||||
|  |  | ||||||
|  | 		typStr := val.Type().Elem().String() | ||||||
|  |  | ||||||
|  | 		for curr := ee; curr != nil; curr = curr.OriginalError { | ||||||
|  | 			if curr.Category == CatForeign && curr.WrappedErrType == typStr && curr.WrappedErr != nil { | ||||||
|  | 				val.Elem().Set(reflect.ValueOf(curr.WrappedErr)) | ||||||
|  | 				return true | ||||||
|  | 			} | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ee *ExErr) Log(evt *zerolog.Event) { | ||||||
|  | 	evt.Msg(ee.FormatLog(LogPrintFull)) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ee *ExErr) FormatLog(lvl LogPrintLevel) string { | ||||||
|  |  | ||||||
|  | 	// [LogPrintShort] | ||||||
|  | 	// | ||||||
|  | 	// - Only print message and type | ||||||
|  | 	// - Used e.g. for logging to the console when Build is called | ||||||
|  | 	// - also used in Print() if level == Warn/Info | ||||||
|  | 	// | ||||||
|  | 	// [LogPrintOverview] | ||||||
|  | 	// | ||||||
|  | 	// - print message, extra and errortrace | ||||||
|  | 	// | ||||||
|  | 	// [LogPrintFull] | ||||||
|  | 	// | ||||||
|  | 	// - print full error, with meta and extra, and trace, etc | ||||||
|  | 	// - Used in Output() and Print() | ||||||
|  | 	// | ||||||
|  |  | ||||||
|  | 	if lvl == LogPrintShort { | ||||||
|  |  | ||||||
|  | 		msg := ee.Message | ||||||
|  | 		if msg == "" { | ||||||
|  | 			msg = ee.RecursiveMessage() | ||||||
|  | 		} | ||||||
|  | 		if ee.OriginalError != nil && ee.OriginalError.Category == CatForeign { | ||||||
|  | 			msg = msg + " (" + strings.ReplaceAll(ee.OriginalError.Message, "\n", " ") + ")" | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		if ee.Type != TypeWrap { | ||||||
|  | 			return "[" + ee.Type.Key + "] " + msg | ||||||
|  | 		} else { | ||||||
|  | 			return msg | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 	} else if lvl == LogPrintOverview { | ||||||
|  |  | ||||||
|  | 		str := "[" + ee.RecursiveType().Key + "] <" + ee.UniqueID + "> " + strings.ReplaceAll(ee.RecursiveMessage(), "\n", " ") + "\n" | ||||||
|  |  | ||||||
|  | 		for exk, exv := range ee.Extra { | ||||||
|  | 			str += fmt.Sprintf(" # [[[ %s ==> %v ]]]\n", exk, exv) | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		indent := "" | ||||||
|  | 		for curr := ee; curr != nil; curr = curr.OriginalError { | ||||||
|  | 			indent += "  " | ||||||
|  |  | ||||||
|  | 			str += indent | ||||||
|  | 			str += "-> " | ||||||
|  | 			strmsg := strings.Trim(curr.Message, " \r\n\t") | ||||||
|  | 			if lbidx := strings.Index(curr.Message, "\n"); lbidx >= 0 { | ||||||
|  | 				strmsg = strmsg[0:lbidx] | ||||||
|  | 			} | ||||||
|  | 			strmsg = langext.StrLimit(strmsg, 61, "...") | ||||||
|  | 			str += strmsg | ||||||
|  | 			str += "\n" | ||||||
|  |  | ||||||
|  | 		} | ||||||
|  | 		return str | ||||||
|  |  | ||||||
|  | 	} else if lvl == LogPrintFull { | ||||||
|  |  | ||||||
|  | 		str := "[" + ee.RecursiveType().Key + "] <" + ee.UniqueID + "> " + strings.ReplaceAll(ee.RecursiveMessage(), "\n", " ") + "\n" | ||||||
|  |  | ||||||
|  | 		for exk, exv := range ee.Extra { | ||||||
|  | 			str += fmt.Sprintf(" # [[[ %s ==> %v ]]]\n", exk, exv) | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		indent := "" | ||||||
|  | 		for curr := ee; curr != nil; curr = curr.OriginalError { | ||||||
|  | 			indent += "  " | ||||||
|  |  | ||||||
|  | 			etype := curr.Type.Key | ||||||
|  | 			if curr.Type == TypeWrap { | ||||||
|  | 				etype = "~" | ||||||
|  | 			} | ||||||
|  |  | ||||||
|  | 			str += indent | ||||||
|  | 			str += "-> [" | ||||||
|  | 			str += etype | ||||||
|  | 			if curr.Category == CatForeign { | ||||||
|  | 				str += "|Foreign" | ||||||
|  | 			} | ||||||
|  | 			str += "] " | ||||||
|  | 			str += strings.ReplaceAll(curr.Message, "\n", " ") | ||||||
|  | 			if curr.Caller != "" { | ||||||
|  | 				str += " (@ " | ||||||
|  | 				str += curr.Caller | ||||||
|  | 				str += ")" | ||||||
|  | 			} | ||||||
|  | 			str += "\n" | ||||||
|  |  | ||||||
|  | 			if curr.Meta.Any() { | ||||||
|  | 				meta := indent + "   {" + curr.Meta.FormatOneLine(240) + "}" | ||||||
|  | 				if len(meta) < 200 { | ||||||
|  | 					str += meta | ||||||
|  | 					str += "\n" | ||||||
|  | 				} else { | ||||||
|  | 					str += curr.Meta.FormatMultiLine(indent+"   ", "  ", 1024) | ||||||
|  | 					str += "\n" | ||||||
|  | 				} | ||||||
|  | 			} | ||||||
|  | 		} | ||||||
|  | 		return str | ||||||
|  |  | ||||||
|  | 	} else { | ||||||
|  |  | ||||||
|  | 		return "[?[" + ee.UniqueID + "]?]" | ||||||
|  |  | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ee *ExErr) ShortLog(evt *zerolog.Event) { | ||||||
|  | 	ee.Meta.Apply(evt, langext.Ptr(240)).Msg(ee.FormatLog(LogPrintShort)) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // RecursiveMessage returns the message to show | ||||||
|  | // = first error (top-down) that is not foreign/empty | ||||||
|  | // = lowest level error (that is not empty) | ||||||
|  | // = fallback to self.message | ||||||
|  | func (ee *ExErr) RecursiveMessage() string { | ||||||
|  |  | ||||||
|  | 	// ==== [1] ==== first error (top-down) that is not wrapping/foreign/empty | ||||||
|  |  | ||||||
|  | 	for curr := ee; curr != nil; curr = curr.OriginalError { | ||||||
|  | 		if curr.Message != "" && curr.Category != CatForeign { | ||||||
|  | 			return curr.Message | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// ==== [2] ==== lowest level error (that is not empty) | ||||||
|  |  | ||||||
|  | 	deepestMsg := "" | ||||||
|  | 	for curr := ee; curr != nil; curr = curr.OriginalError { | ||||||
|  | 		if curr.Message != "" { | ||||||
|  | 			deepestMsg = curr.Message | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | 	if deepestMsg != "" { | ||||||
|  | 		return deepestMsg | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// ==== [3] ==== fallback to self.message | ||||||
|  |  | ||||||
|  | 	return ee.Message | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // RecursiveType returns the statuscode to use | ||||||
|  | // = first error (top-down) that is not wrapping/empty | ||||||
|  | func (ee *ExErr) RecursiveType() ErrorType { | ||||||
|  | 	for curr := ee; curr != nil; curr = curr.OriginalError { | ||||||
|  | 		if curr.Type != TypeWrap { | ||||||
|  | 			return curr.Type | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// fallback to self | ||||||
|  | 	return ee.Type | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // RecursiveStatuscode returns the HTTP Statuscode to use | ||||||
|  | // = first error (top-down) that has a statuscode set | ||||||
|  | func (ee *ExErr) RecursiveStatuscode() *int { | ||||||
|  | 	for curr := ee; curr != nil; curr = curr.OriginalError { | ||||||
|  | 		if curr.StatusCode != nil { | ||||||
|  | 			return langext.Ptr(*curr.StatusCode) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return nil | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // RecursiveCategory returns the ErrorCategory to use | ||||||
|  | // = first error (top-down) that has a statuscode set | ||||||
|  | func (ee *ExErr) RecursiveCategory() ErrorCategory { | ||||||
|  | 	for curr := ee; curr != nil; curr = curr.OriginalError { | ||||||
|  | 		if curr.Category != CatWrap { | ||||||
|  | 			return curr.Category | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	// fallback to <empty> | ||||||
|  | 	return ee.Category | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // RecursiveMeta searches (top-down) for teh first error that has a meta value with teh specified key | ||||||
|  | // and returns its value (or nil) | ||||||
|  | func (ee *ExErr) RecursiveMeta(key string) *MetaValue { | ||||||
|  | 	for curr := ee; curr != nil; curr = curr.OriginalError { | ||||||
|  | 		if metaval, ok := curr.Meta[key]; ok { | ||||||
|  | 			return langext.Ptr(metaval) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return nil | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // Depth returns the depth of recursively contained errors | ||||||
|  | func (ee *ExErr) Depth() int { | ||||||
|  | 	if ee.OriginalError == nil { | ||||||
|  | 		return 1 | ||||||
|  | 	} else { | ||||||
|  | 		return ee.OriginalError.Depth() + 1 | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // GetMeta returns the meta value with the specified key | ||||||
|  | // this method recurses through all wrapped errors and returns the first matching meta value | ||||||
|  | func (ee *ExErr) GetMeta(key string) (any, bool) { | ||||||
|  | 	for curr := ee; curr != nil; curr = curr.OriginalError { | ||||||
|  | 		if v, ok := curr.Meta[key]; ok { | ||||||
|  | 			return v.Value, true | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return nil, false | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // GetMetaString functions the same as GetMeta, but returns false if the type does not match | ||||||
|  | func (ee *ExErr) GetMetaString(key string) (string, bool) { | ||||||
|  | 	if v1, ok := ee.GetMeta(key); ok { | ||||||
|  | 		if v2, ok := v1.(string); ok { | ||||||
|  | 			return v2, true | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | 	return "", false | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ee *ExErr) GetMetaBool(key string) (bool, bool) { | ||||||
|  | 	if v1, ok := ee.GetMeta(key); ok { | ||||||
|  | 		if v2, ok := v1.(bool); ok { | ||||||
|  | 			return v2, true | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | 	return false, false | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ee *ExErr) GetMetaInt(key string) (int, bool) { | ||||||
|  | 	if v1, ok := ee.GetMeta(key); ok { | ||||||
|  | 		if v2, ok := v1.(int); ok { | ||||||
|  | 			return v2, true | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | 	return 0, false | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ee *ExErr) GetMetaFloat32(key string) (float32, bool) { | ||||||
|  | 	if v1, ok := ee.GetMeta(key); ok { | ||||||
|  | 		if v2, ok := v1.(float32); ok { | ||||||
|  | 			return v2, true | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | 	return 0, false | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ee *ExErr) GetMetaFloat64(key string) (float64, bool) { | ||||||
|  | 	if v1, ok := ee.GetMeta(key); ok { | ||||||
|  | 		if v2, ok := v1.(float64); ok { | ||||||
|  | 			return v2, true | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | 	return 0, false | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ee *ExErr) GetMetaTime(key string) (time.Time, bool) { | ||||||
|  | 	if v1, ok := ee.GetMeta(key); ok { | ||||||
|  | 		if v2, ok := v1.(time.Time); ok { | ||||||
|  | 			return v2, true | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | 	return time.Time{}, false | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ee *ExErr) GetExtra(key string) (any, bool) { | ||||||
|  | 	if v, ok := ee.Extra[key]; ok { | ||||||
|  | 		return v, true | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return nil, false | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ee *ExErr) UniqueIDs() []string { | ||||||
|  | 	ids := make([]string, 0, 1) | ||||||
|  | 	for curr := ee; curr != nil; curr = curr.OriginalError { | ||||||
|  | 		ids = append(ids, curr.UniqueID) | ||||||
|  | 	} | ||||||
|  | 	return ids | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // contains test if the supplied error is contained in this error (anywhere in the chain) | ||||||
|  | func (ee *ExErr) contains(original *ExErr) (*ExErr, bool) { | ||||||
|  | 	if original == nil { | ||||||
|  | 		return nil, false | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if ee == original { | ||||||
|  | 		return ee, true | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	for curr := ee; curr != nil; curr = curr.OriginalError { | ||||||
|  | 		if curr.equalsDirectProperties(curr) { | ||||||
|  | 			return curr, true | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return nil, false | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // equalsDirectProperties tests if ee and other are equals, but only looks at primary properties (not `OriginalError` or `Meta`) | ||||||
|  | func (ee *ExErr) equalsDirectProperties(other *ExErr) bool { | ||||||
|  |  | ||||||
|  | 	if ee.UniqueID != other.UniqueID { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  | 	if ee.Timestamp != other.Timestamp { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  | 	if ee.Category != other.Category { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  | 	if ee.Severity != other.Severity { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  | 	if ee.Type != other.Type { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  | 	if ee.StatusCode != other.StatusCode { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  | 	if ee.Message != other.Message { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  | 	if ee.WrappedErrType != other.WrappedErrType { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  | 	if ee.Caller != other.Caller { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return true | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func newID() string { | ||||||
|  | 	return xid.New().String() | ||||||
| } | } | ||||||
|   | |||||||
							
								
								
									
										102
									
								
								exerr/exerr_test.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										102
									
								
								exerr/exerr_test.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,102 @@ | |||||||
|  | package exerr | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"errors" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/tst" | ||||||
|  | 	"os" | ||||||
|  | 	"testing" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | func TestMain(m *testing.M) { | ||||||
|  | 	if !Initialized() { | ||||||
|  | 		Init(ErrorPackageConfigInit{ZeroLogErrTraces: langext.PFalse, ZeroLogAllTraces: langext.PFalse}) | ||||||
|  | 	} | ||||||
|  | 	os.Exit(m.Run()) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type golangErr struct { | ||||||
|  | 	Message string | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (g golangErr) Error() string { | ||||||
|  | 	return g.Message | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type golangErr2 struct { | ||||||
|  | 	Message string | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (g golangErr2) Error() string { | ||||||
|  | 	return g.Message | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type simpleError struct { | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (g simpleError) Error() string { | ||||||
|  | 	return "Something simple went wroong" | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type simpleError2 struct { | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (g simpleError2) Error() string { | ||||||
|  | 	return "Something simple went wroong" | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestExErrIs1(t *testing.T) { | ||||||
|  | 	e0 := simpleError{} | ||||||
|  |  | ||||||
|  | 	wrap := Wrap(e0, "something went wrong").Str("test", "123").Build() | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, errors.Is(wrap, simpleError{})) | ||||||
|  | 	tst.AssertFalse(t, errors.Is(wrap, golangErr{})) | ||||||
|  | 	tst.AssertFalse(t, errors.Is(wrap, golangErr{"error1"})) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestExErrIs2(t *testing.T) { | ||||||
|  | 	e0 := golangErr{"error1"} | ||||||
|  |  | ||||||
|  | 	wrap := Wrap(e0, "something went wrong").Str("test", "123").Build() | ||||||
|  |  | ||||||
|  | 	tst.AssertTrue(t, errors.Is(wrap, e0)) | ||||||
|  | 	tst.AssertTrue(t, errors.Is(wrap, golangErr{"error1"})) | ||||||
|  | 	tst.AssertFalse(t, errors.Is(wrap, golangErr{"error2"})) | ||||||
|  | 	tst.AssertFalse(t, errors.Is(wrap, simpleError{})) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func TestExErrAs(t *testing.T) { | ||||||
|  |  | ||||||
|  | 	e0 := golangErr{"error1"} | ||||||
|  |  | ||||||
|  | 	w0 := Wrap(e0, "something went wrong").Str("test", "123").Build() | ||||||
|  |  | ||||||
|  | 	{ | ||||||
|  | 		out := golangErr{} | ||||||
|  | 		ok := errors.As(w0, &out) | ||||||
|  | 		tst.AssertTrue(t, ok) | ||||||
|  | 		tst.AssertEqual(t, out.Message, "error1") | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	w1 := Wrap(w0, "outher error").Build() | ||||||
|  |  | ||||||
|  | 	{ | ||||||
|  | 		out := golangErr{} | ||||||
|  | 		ok := errors.As(w1, &out) | ||||||
|  | 		tst.AssertTrue(t, ok) | ||||||
|  | 		tst.AssertEqual(t, out.Message, "error1") | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	{ | ||||||
|  | 		out := golangErr2{} | ||||||
|  | 		ok := errors.As(w1, &out) | ||||||
|  | 		tst.AssertFalse(t, ok) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	{ | ||||||
|  | 		out := simpleError2{} | ||||||
|  | 		ok := errors.As(w1, &out) | ||||||
|  | 		tst.AssertFalse(t, ok) | ||||||
|  | 	} | ||||||
|  | } | ||||||
							
								
								
									
										146
									
								
								exerr/foreign.go
									
									
									
									
									
								
							
							
						
						
									
										146
									
								
								exerr/foreign.go
									
									
									
									
									
								
							| @@ -1,146 +0,0 @@ | |||||||
| package exerr |  | ||||||
|  |  | ||||||
| import ( |  | ||||||
| 	"bringman.de/common/shared/langext" |  | ||||||
| 	"encoding/json" |  | ||||||
| 	"go.mongodb.org/mongo-driver/bson/primitive" |  | ||||||
| 	"reflect" |  | ||||||
| 	"time" |  | ||||||
| ) |  | ||||||
|  |  | ||||||
| var reflectTypeStr = reflect.TypeOf("") |  | ||||||
|  |  | ||||||
| func getForeignMeta(err error) (mm MetaMap) { |  | ||||||
| 	mm = make(map[string]MetaValue) |  | ||||||
|  |  | ||||||
| 	defer func() { |  | ||||||
| 		if panicerr := recover(); panicerr != nil { |  | ||||||
| 			New(ErrPanic, "Panic while trying to get foreign meta"). |  | ||||||
| 				Str("source", err.Error()). |  | ||||||
| 				Interface("panic-object", panicerr). |  | ||||||
| 				Stack(). |  | ||||||
| 				Print() |  | ||||||
| 		} |  | ||||||
| 	}() |  | ||||||
|  |  | ||||||
| 	rval := reflect.ValueOf(err) |  | ||||||
| 	if rval.Kind() == reflect.Interface || rval.Kind() == reflect.Ptr { |  | ||||||
| 		rval = reflect.ValueOf(err).Elem() |  | ||||||
| 	} |  | ||||||
|  |  | ||||||
| 	mm.add("foreign.errortype", MDTString, rval.Type().String()) |  | ||||||
|  |  | ||||||
| 	for k, v := range addMetaPrefix("foreign", getReflectedMetaValues(err, 8)) { |  | ||||||
| 		mm[k] = v |  | ||||||
| 	} |  | ||||||
|  |  | ||||||
| 	return mm |  | ||||||
| } |  | ||||||
|  |  | ||||||
| func getReflectedMetaValues(value interface{}, remainingDepth int) map[string]MetaValue { |  | ||||||
|  |  | ||||||
| 	if remainingDepth <= 0 { |  | ||||||
| 		return map[string]MetaValue{} |  | ||||||
| 	} |  | ||||||
|  |  | ||||||
| 	if langext.IsNil(value) { |  | ||||||
| 		return map[string]MetaValue{"": {DataType: MDTNil, Value: nil}} |  | ||||||
| 	} |  | ||||||
|  |  | ||||||
| 	rval := reflect.ValueOf(value) |  | ||||||
|  |  | ||||||
| 	if rval.Type().Kind() == reflect.Ptr { |  | ||||||
|  |  | ||||||
| 		if rval.IsNil() { |  | ||||||
| 			return map[string]MetaValue{"*": {DataType: MDTNil, Value: nil}} |  | ||||||
| 		} |  | ||||||
|  |  | ||||||
| 		elem := rval.Elem() |  | ||||||
|  |  | ||||||
| 		return addMetaPrefix("*", getReflectedMetaValues(elem.Interface(), remainingDepth-1)) |  | ||||||
| 	} |  | ||||||
|  |  | ||||||
| 	if !rval.CanInterface() { |  | ||||||
| 		return map[string]MetaValue{"": {DataType: MDTString, Value: "<<no-interface>>"}} |  | ||||||
| 	} |  | ||||||
|  |  | ||||||
| 	raw := rval.Interface() |  | ||||||
|  |  | ||||||
| 	switch ifraw := raw.(type) { |  | ||||||
| 	case time.Time: |  | ||||||
| 		return map[string]MetaValue{"": {DataType: MDTTime, Value: ifraw}} |  | ||||||
| 	case time.Duration: |  | ||||||
| 		return map[string]MetaValue{"": {DataType: MDTDuration, Value: ifraw}} |  | ||||||
| 	case int: |  | ||||||
| 		return map[string]MetaValue{"": {DataType: MDTInt, Value: ifraw}} |  | ||||||
| 	case int8: |  | ||||||
| 		return map[string]MetaValue{"": {DataType: MDTInt8, Value: ifraw}} |  | ||||||
| 	case int16: |  | ||||||
| 		return map[string]MetaValue{"": {DataType: MDTInt16, Value: ifraw}} |  | ||||||
| 	case int32: |  | ||||||
| 		return map[string]MetaValue{"": {DataType: MDTInt32, Value: ifraw}} |  | ||||||
| 	case int64: |  | ||||||
| 		return map[string]MetaValue{"": {DataType: MDTInt64, Value: ifraw}} |  | ||||||
| 	case string: |  | ||||||
| 		return map[string]MetaValue{"": {DataType: MDTString, Value: ifraw}} |  | ||||||
| 	case bool: |  | ||||||
| 		return map[string]MetaValue{"": {DataType: MDTBool, Value: ifraw}} |  | ||||||
| 	case []byte: |  | ||||||
| 		return map[string]MetaValue{"": {DataType: MDTBytes, Value: ifraw}} |  | ||||||
| 	case float32: |  | ||||||
| 		return map[string]MetaValue{"": {DataType: MDTFloat32, Value: ifraw}} |  | ||||||
| 	case float64: |  | ||||||
| 		return map[string]MetaValue{"": {DataType: MDTFloat64, Value: ifraw}} |  | ||||||
| 	case []int: |  | ||||||
| 		return map[string]MetaValue{"": {DataType: MDTIntArray, Value: ifraw}} |  | ||||||
| 	case []int32: |  | ||||||
| 		return map[string]MetaValue{"": {DataType: MDTInt32Array, Value: ifraw}} |  | ||||||
| 	case primitive.ObjectID: |  | ||||||
| 		return map[string]MetaValue{"": {DataType: MDTObjectID, Value: ifraw}} |  | ||||||
| 	case []string: |  | ||||||
| 		return map[string]MetaValue{"": {DataType: MDTStringArray, Value: ifraw}} |  | ||||||
| 	} |  | ||||||
|  |  | ||||||
| 	if rval.Type().Kind() == reflect.Struct { |  | ||||||
| 		m := make(map[string]MetaValue) |  | ||||||
| 		for i := 0; i < rval.NumField(); i++ { |  | ||||||
| 			fieldtype := rval.Type().Field(i) |  | ||||||
|  |  | ||||||
| 			fieldname := fieldtype.Name |  | ||||||
|  |  | ||||||
| 			if fieldtype.IsExported() { |  | ||||||
| 				for k, v := range addMetaPrefix(fieldname, getReflectedMetaValues(rval.Field(i).Interface(), remainingDepth-1)) { |  | ||||||
| 					m[k] = v |  | ||||||
| 				} |  | ||||||
| 			} |  | ||||||
| 		} |  | ||||||
| 		return m |  | ||||||
| 	} |  | ||||||
|  |  | ||||||
| 	if rval.Type().ConvertibleTo(reflectTypeStr) { |  | ||||||
| 		return map[string]MetaValue{"": {DataType: MDTString, Value: rval.Convert(reflectTypeStr).String()}} |  | ||||||
| 	} |  | ||||||
|  |  | ||||||
| 	jsonval, err := json.Marshal(value) |  | ||||||
| 	if err != nil { |  | ||||||
| 		panic(err) // gets recovered later up |  | ||||||
| 	} |  | ||||||
|  |  | ||||||
| 	return map[string]MetaValue{"": {DataType: MDTString, Value: string(jsonval)}} |  | ||||||
| } |  | ||||||
|  |  | ||||||
| func addMetaPrefix(prefix string, m map[string]MetaValue) map[string]MetaValue { |  | ||||||
| 	if len(m) == 1 { |  | ||||||
| 		for k, v := range m { |  | ||||||
| 			if k == "" { |  | ||||||
| 				return map[string]MetaValue{prefix: v} |  | ||||||
| 			} |  | ||||||
| 		} |  | ||||||
| 	} |  | ||||||
|  |  | ||||||
| 	r := make(map[string]MetaValue, len(m)) |  | ||||||
| 	for k, v := range m { |  | ||||||
| 		r[prefix+"."+k] = v |  | ||||||
| 	} |  | ||||||
| 	return r |  | ||||||
| } |  | ||||||
							
								
								
									
										175
									
								
								exerr/gin.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										175
									
								
								exerr/gin.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,175 @@ | |||||||
|  | package exerr | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	json "git.blackforestbytes.com/BlackForestBytes/goext/gojson" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | 	"github.com/gin-gonic/gin" | ||||||
|  | 	"net/http" | ||||||
|  | 	"time" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | func (ee *ExErr) toJson(depth int, applyExtendListener bool, outputMeta bool) langext.H { | ||||||
|  | 	ginJson := langext.H{} | ||||||
|  |  | ||||||
|  | 	if ee.UniqueID != "" { | ||||||
|  | 		ginJson["id"] = ee.UniqueID | ||||||
|  | 	} | ||||||
|  | 	if ee.Category != CatWrap { | ||||||
|  | 		ginJson["category"] = ee.Category.Category | ||||||
|  | 	} | ||||||
|  | 	if ee.Type != TypeWrap { | ||||||
|  | 		ginJson["type"] = ee.Type.Key | ||||||
|  | 	} | ||||||
|  | 	if ee.StatusCode != nil { | ||||||
|  | 		ginJson["statuscode"] = ee.StatusCode | ||||||
|  | 	} | ||||||
|  | 	if ee.Message != "" { | ||||||
|  | 		ginJson["message"] = ee.Message | ||||||
|  | 	} | ||||||
|  | 	if ee.Caller != "" { | ||||||
|  | 		ginJson["caller"] = ee.Caller | ||||||
|  | 	} | ||||||
|  | 	if ee.Severity != SevErr { | ||||||
|  | 		ginJson["severity"] = ee.Severity.Severity | ||||||
|  | 	} | ||||||
|  | 	if ee.Timestamp != (time.Time{}) { | ||||||
|  | 		ginJson["time"] = ee.Timestamp.Format(time.RFC3339) | ||||||
|  | 	} | ||||||
|  | 	if ee.WrappedErrType != "" { | ||||||
|  | 		ginJson["wrappedErrType"] = ee.WrappedErrType | ||||||
|  | 	} | ||||||
|  | 	if ee.OriginalError != nil { | ||||||
|  | 		ginJson["original"] = ee.OriginalError.toJson(depth+1, applyExtendListener, outputMeta) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if outputMeta { | ||||||
|  | 		metaJson := langext.H{} | ||||||
|  | 		for metaKey, metaVal := range ee.Meta { | ||||||
|  | 			metaJson[metaKey] = metaVal.rawValueForJson() | ||||||
|  | 		} | ||||||
|  | 		ginJson["meta"] = metaJson | ||||||
|  |  | ||||||
|  | 		extraJson := langext.H{} | ||||||
|  | 		for extraKey, extraVal := range ee.Extra { | ||||||
|  | 			extraJson[extraKey] = extraVal | ||||||
|  | 		} | ||||||
|  | 		ginJson["extra"] = extraJson | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if applyExtendListener { | ||||||
|  | 		pkgconfig.ExtendGinDataOutput(ee, depth, ginJson) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return ginJson | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ee *ExErr) ToDefaultAPIJson() (string, error) { | ||||||
|  |  | ||||||
|  | 	gjr := json.GoJsonRender{Data: ee.ToAPIJson(true, pkgconfig.ExtendedGinOutput, pkgconfig.IncludeMetaInGinOutput), NilSafeSlices: true, NilSafeMaps: true} | ||||||
|  |  | ||||||
|  | 	r, err := gjr.RenderString() | ||||||
|  | 	if err != nil { | ||||||
|  | 		return "", err | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return r, nil | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // ToAPIJson converts the ExError to a json object | ||||||
|  | // (the same object as used in the Output(gin) method) | ||||||
|  | // | ||||||
|  | // Parameters: | ||||||
|  | //   - [applyExtendListener]:  if false the pkgconfig.ExtendGinOutput / pkgconfig.ExtendGinDataOutput will not be applied | ||||||
|  | //   - [includeWrappedErrors]: if false we do not include the recursive/wrapped errors in `__data` | ||||||
|  | //   - [includeMetaFields]:    if true  we also include meta-values (aka from `.Str(key, value).Build()`), needs includeWrappedErrors=true | ||||||
|  | func (ee *ExErr) ToAPIJson(applyExtendListener bool, includeWrappedErrors bool, includeMetaFields bool) langext.H { | ||||||
|  |  | ||||||
|  | 	apiOutput := langext.H{ | ||||||
|  | 		"errorid":   ee.UniqueID, | ||||||
|  | 		"message":   ee.RecursiveMessage(), | ||||||
|  | 		"errorcode": ee.RecursiveType().Key, | ||||||
|  | 		"category":  ee.RecursiveCategory().Category, | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if includeWrappedErrors { | ||||||
|  | 		apiOutput["__data"] = ee.toJson(0, applyExtendListener, includeMetaFields) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	for exkey, exval := range ee.Extra { | ||||||
|  |  | ||||||
|  | 		// ensure we do not override existing values | ||||||
|  | 		for { | ||||||
|  | 			if _, ok := apiOutput[exkey]; ok { | ||||||
|  | 				exkey = "_" + exkey | ||||||
|  | 			} else { | ||||||
|  | 				break | ||||||
|  | 			} | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		apiOutput[exkey] = exval | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if applyExtendListener { | ||||||
|  | 		pkgconfig.ExtendGinOutput(ee, apiOutput) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return apiOutput | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ee *ExErr) Output(g *gin.Context) { | ||||||
|  |  | ||||||
|  | 	warnOnPkgConfigNotInitialized() | ||||||
|  |  | ||||||
|  | 	var statuscode = http.StatusInternalServerError | ||||||
|  |  | ||||||
|  | 	var baseCat = ee.RecursiveCategory() | ||||||
|  | 	var baseType = ee.RecursiveType() | ||||||
|  | 	var baseStatuscode = ee.RecursiveStatuscode() | ||||||
|  |  | ||||||
|  | 	if baseCat == CatUser { | ||||||
|  | 		statuscode = http.StatusBadRequest | ||||||
|  | 	} else if baseCat == CatSystem { | ||||||
|  | 		statuscode = http.StatusInternalServerError | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if baseStatuscode != nil { | ||||||
|  | 		statuscode = *ee.StatusCode | ||||||
|  | 	} else if baseType.DefaultStatusCode != nil { | ||||||
|  | 		statuscode = *baseType.DefaultStatusCode | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	ginOutput := ee.ToAPIJson(true, pkgconfig.ExtendedGinOutput, pkgconfig.IncludeMetaInGinOutput) | ||||||
|  |  | ||||||
|  | 	g.Render(statuscode, json.GoJsonRender{Data: ginOutput, NilSafeSlices: true, NilSafeMaps: true}) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ee *ExErr) OutputRaw(w http.ResponseWriter) { | ||||||
|  |  | ||||||
|  | 	warnOnPkgConfigNotInitialized() | ||||||
|  |  | ||||||
|  | 	var statuscode = http.StatusInternalServerError | ||||||
|  |  | ||||||
|  | 	var baseCat = ee.RecursiveCategory() | ||||||
|  | 	var baseType = ee.RecursiveType() | ||||||
|  | 	var baseStatuscode = ee.RecursiveStatuscode() | ||||||
|  |  | ||||||
|  | 	if baseCat == CatUser { | ||||||
|  | 		statuscode = http.StatusBadRequest | ||||||
|  | 	} else if baseCat == CatSystem { | ||||||
|  | 		statuscode = http.StatusInternalServerError | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if baseStatuscode != nil { | ||||||
|  | 		statuscode = *ee.StatusCode | ||||||
|  | 	} else if baseType.DefaultStatusCode != nil { | ||||||
|  | 		statuscode = *baseType.DefaultStatusCode | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	ginOutput, err := ee.ToDefaultAPIJson() | ||||||
|  | 	if err != nil { | ||||||
|  | 		panic(err) // cannot happen | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	w.WriteHeader(statuscode) | ||||||
|  | 	_, _ = w.Write([]byte(ginOutput)) | ||||||
|  | } | ||||||
							
								
								
									
										126
									
								
								exerr/helper.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										126
									
								
								exerr/helper.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,126 @@ | |||||||
|  | package exerr | ||||||
|  |  | ||||||
|  | import "fmt" | ||||||
|  |  | ||||||
|  | // IsType test if the supplied error is of the specified ErrorType. | ||||||
|  | func IsType(err error, errType ErrorType) bool { | ||||||
|  | 	if err == nil { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	bmerr := FromError(err) | ||||||
|  | 	for bmerr != nil { | ||||||
|  | 		if bmerr.Type == errType { | ||||||
|  | 			return true | ||||||
|  | 		} | ||||||
|  | 		bmerr = bmerr.OriginalError | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return false | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // IsFrom test if the supplied error stems originally from original | ||||||
|  | func IsFrom(e error, original error) bool { | ||||||
|  | 	if e == nil { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	//goland:noinspection GoDirectComparisonOfErrors | ||||||
|  | 	if e == original { | ||||||
|  | 		return true | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	bmerr := FromError(e) | ||||||
|  | 	for bmerr == nil { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	for curr := bmerr; curr != nil; curr = curr.OriginalError { | ||||||
|  | 		if curr.Category == CatForeign && curr.Message == original.Error() && curr.WrappedErrType == fmt.Sprintf("%T", original) { | ||||||
|  | 			return true | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return false | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // HasSourceMessage tests if the supplied error stems originally from an error with the message msg | ||||||
|  | func HasSourceMessage(e error, msg string) bool { | ||||||
|  | 	if e == nil { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	bmerr := FromError(e) | ||||||
|  | 	for bmerr == nil { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	for curr := bmerr; curr != nil; curr = curr.OriginalError { | ||||||
|  | 		if curr.OriginalError == nil && curr.Message == msg { | ||||||
|  | 			return true | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return false | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func MessageMatch(e error, matcher func(string) bool) bool { | ||||||
|  | 	if e == nil { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if matcher(e.Error()) { | ||||||
|  | 		return true | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	bmerr := FromError(e) | ||||||
|  | 	for bmerr == nil { | ||||||
|  | 		return false | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	for curr := bmerr; curr != nil; curr = curr.OriginalError { | ||||||
|  | 		if matcher(curr.Message) { | ||||||
|  | 			return true | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return false | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // OriginalError returns the lowest level error, probably the original/external error that was originally wrapped | ||||||
|  | func OriginalError(e error) error { | ||||||
|  | 	if e == nil { | ||||||
|  | 		return nil | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	//goland:noinspection GoTypeAssertionOnErrors | ||||||
|  | 	bmerr, ok := e.(*ExErr) | ||||||
|  | 	for !ok { | ||||||
|  | 		return e | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	for bmerr.OriginalError != nil { | ||||||
|  | 		bmerr = bmerr.OriginalError | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if bmerr.WrappedErr != nil { | ||||||
|  | 		if werr, ok := bmerr.WrappedErr.(error); ok { | ||||||
|  | 			return werr | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return bmerr | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func UniqueID(v error) *string { | ||||||
|  | 	if v == nil { | ||||||
|  | 		return nil | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	//goland:noinspection GoTypeAssertionOnErrors | ||||||
|  | 	if verr, ok := v.(*ExErr); ok { | ||||||
|  | 		return &verr.UniqueID | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return nil | ||||||
|  | } | ||||||
| @@ -4,16 +4,11 @@ import ( | |||||||
| 	"sync" | 	"sync" | ||||||
| ) | ) | ||||||
|  |  | ||||||
| type Method string | type ListenerOpt struct { | ||||||
|  | 	NoLog bool | ||||||
|  | } | ||||||
|  |  | ||||||
| const ( | type Listener = func(method Method, v *ExErr, opt ListenerOpt) | ||||||
| 	MethodOutput Method = "OUTPUT" |  | ||||||
| 	MethodPrint  Method = "PRINT" |  | ||||||
| 	MethodBuild  Method = "BUILD" |  | ||||||
| 	MethodFatal  Method = "FATAL" |  | ||||||
| ) |  | ||||||
|  |  | ||||||
| type Listener = func(method Method, v ExErr) |  | ||||||
|  |  | ||||||
| var listenerLock = sync.Mutex{} | var listenerLock = sync.Mutex{} | ||||||
| var listener = make([]Listener, 0) | var listener = make([]Listener, 0) | ||||||
| @@ -25,13 +20,11 @@ func RegisterListener(l Listener) { | |||||||
| 	listener = append(listener, l) | 	listener = append(listener, l) | ||||||
| } | } | ||||||
|  |  | ||||||
| func (b *Builder) CallListener(m Method) { | func (ee *ExErr) CallListener(m Method, opt ListenerOpt) { | ||||||
| 	valErr := b.toBMError() |  | ||||||
|  |  | ||||||
| 	listenerLock.Lock() | 	listenerLock.Lock() | ||||||
| 	defer listenerLock.Unlock() | 	defer listenerLock.Unlock() | ||||||
|  |  | ||||||
| 	for _, v := range listener { | 	for _, v := range listener { | ||||||
| 		v(m, valErr) | 		v(m, ee, opt) | ||||||
| 	} | 	} | ||||||
| } | } | ||||||
|   | |||||||
							
								
								
									
										171
									
								
								exerr/meta.go
									
									
									
									
									
								
							
							
						
						
									
										171
									
								
								exerr/meta.go
									
									
									
									
									
								
							| @@ -5,16 +5,20 @@ import ( | |||||||
| 	"encoding/json" | 	"encoding/json" | ||||||
| 	"errors" | 	"errors" | ||||||
| 	"fmt" | 	"fmt" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
| 	"github.com/rs/zerolog" | 	"github.com/rs/zerolog" | ||||||
| 	"github.com/rs/zerolog/log" |  | ||||||
| 	"go.mongodb.org/mongo-driver/bson" | 	"go.mongodb.org/mongo-driver/bson" | ||||||
| 	"go.mongodb.org/mongo-driver/bson/primitive" | 	"go.mongodb.org/mongo-driver/bson/primitive" | ||||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/langext" | 	"math" | ||||||
| 	"strconv" | 	"strconv" | ||||||
| 	"strings" | 	"strings" | ||||||
| 	"time" | 	"time" | ||||||
| ) | ) | ||||||
|  |  | ||||||
|  | // This is a buffed up map[string]any | ||||||
|  | // we also save type information of the map-values | ||||||
|  | // which allows us to deserialize them back into te correct types later | ||||||
|  |  | ||||||
| type MetaMap map[string]MetaValue | type MetaMap map[string]MetaValue | ||||||
|  |  | ||||||
| type metaDataType string | type metaDataType string | ||||||
| @@ -40,6 +44,7 @@ const ( | |||||||
| 	MDTID          metaDataType = "ID" | 	MDTID          metaDataType = "ID" | ||||||
| 	MDTAny         metaDataType = "Interface" | 	MDTAny         metaDataType = "Interface" | ||||||
| 	MDTNil         metaDataType = "Nil" | 	MDTNil         metaDataType = "Nil" | ||||||
|  | 	MDTEnum        metaDataType = "Enum" | ||||||
| ) | ) | ||||||
|  |  | ||||||
| type MetaValue struct { | type MetaValue struct { | ||||||
| @@ -128,6 +133,8 @@ func (v MetaValue) SerializeValue() (string, error) { | |||||||
| 		return string(r), nil | 		return string(r), nil | ||||||
| 	case MDTNil: | 	case MDTNil: | ||||||
| 		return "", nil | 		return "", nil | ||||||
|  | 	case MDTEnum: | ||||||
|  | 		return v.Value.(EnumWrap).Serialize(), nil | ||||||
| 	} | 	} | ||||||
| 	return "", errors.New("Unknown type: " + string(v.DataType)) | 	return "", errors.New("Unknown type: " + string(v.DataType)) | ||||||
| } | } | ||||||
| @@ -205,27 +212,41 @@ func (v MetaValue) ShortString(lim int) string { | |||||||
| 		return langext.StrLimit(string(r), lim, "...") | 		return langext.StrLimit(string(r), lim, "...") | ||||||
| 	case MDTNil: | 	case MDTNil: | ||||||
| 		return "<<null>>" | 		return "<<null>>" | ||||||
|  | 	case MDTEnum: | ||||||
|  | 		return v.Value.(EnumWrap).String() | ||||||
| 	} | 	} | ||||||
| 	return "(err)" | 	return "(err)" | ||||||
| } | } | ||||||
|  |  | ||||||
| func (v MetaValue) Apply(key string, evt *zerolog.Event) *zerolog.Event { | func (v MetaValue) Apply(key string, evt *zerolog.Event, limitLen *int) *zerolog.Event { | ||||||
| 	switch v.DataType { | 	switch v.DataType { | ||||||
| 	case MDTString: | 	case MDTString: | ||||||
| 		return evt.Str(key, v.Value.(string)) | 		if limitLen == nil { | ||||||
|  | 			return evt.Str(key, v.Value.(string)) | ||||||
|  | 		} else { | ||||||
|  | 			return evt.Str(key, langext.StrLimit(v.Value.(string), *limitLen, "...")) | ||||||
|  | 		} | ||||||
| 	case MDTID: | 	case MDTID: | ||||||
| 		return evt.Str(key, v.Value.(IDWrap).Value) | 		return evt.Str(key, v.Value.(IDWrap).Value) | ||||||
| 	case MDTAny: | 	case MDTAny: | ||||||
| 		if v.Value.(AnyWrap).IsError { | 		if v.Value.(AnyWrap).IsError { | ||||||
| 			return evt.Str(key, "(err)") | 			return evt.Str(key, "(err)") | ||||||
| 		} else { | 		} else { | ||||||
| 			return evt.Str(key, v.Value.(AnyWrap).Json) | 			if limitLen == nil { | ||||||
|  | 				return evt.Str(key, v.Value.(AnyWrap).Json) | ||||||
|  | 			} else { | ||||||
|  | 				return evt.Str(key, langext.StrLimit(v.Value.(AnyWrap).Json, *limitLen, "...")) | ||||||
|  | 			} | ||||||
| 		} | 		} | ||||||
| 	case MDTStringPtr: | 	case MDTStringPtr: | ||||||
| 		if langext.IsNil(v.Value) { | 		if langext.IsNil(v.Value) { | ||||||
| 			return evt.Str(key, "<<null>>") | 			return evt.Str(key, "<<null>>") | ||||||
| 		} | 		} | ||||||
| 		return evt.Str(key, langext.CoalesceString(v.Value.(*string), "<<null>>")) | 		if limitLen == nil { | ||||||
|  | 			return evt.Str(key, langext.CoalesceString(v.Value.(*string), "<<null>>")) | ||||||
|  | 		} else { | ||||||
|  | 			return evt.Str(key, langext.StrLimit(langext.CoalesceString(v.Value.(*string), "<<null>>"), *limitLen, "...")) | ||||||
|  | 		} | ||||||
| 	case MDTInt: | 	case MDTInt: | ||||||
| 		return evt.Int(key, v.Value.(int)) | 		return evt.Int(key, v.Value.(int)) | ||||||
| 	case MDTInt8: | 	case MDTInt8: | ||||||
| @@ -267,6 +288,14 @@ func (v MetaValue) Apply(key string, evt *zerolog.Event) *zerolog.Event { | |||||||
| 		return evt.Ints32(key, v.Value.([]int32)) | 		return evt.Ints32(key, v.Value.([]int32)) | ||||||
| 	case MDTNil: | 	case MDTNil: | ||||||
| 		return evt.Str(key, "<<null>>") | 		return evt.Str(key, "<<null>>") | ||||||
|  | 	case MDTEnum: | ||||||
|  | 		if v.Value.(EnumWrap).IsNil { | ||||||
|  | 			return evt.Any(key, nil) | ||||||
|  | 		} else if v.Value.(EnumWrap).ValueRaw != nil { | ||||||
|  | 			return evt.Any(key, v.Value.(EnumWrap).ValueRaw) | ||||||
|  | 		} else { | ||||||
|  | 			return evt.Str(key, v.Value.(EnumWrap).ValueString) | ||||||
|  | 		} | ||||||
| 	} | 	} | ||||||
| 	return evt.Str(key, "(err)") | 	return evt.Str(key, "(err)") | ||||||
| } | } | ||||||
| @@ -350,11 +379,7 @@ func (v *MetaValue) Deserialize(value string, datatype metaDataType) error { | |||||||
| 			v.DataType = datatype | 			v.DataType = datatype | ||||||
| 			return nil | 			return nil | ||||||
| 		} else { | 		} else { | ||||||
| 			r, err := valueFromProto(value[1:], MDTString) | 			v.Value = langext.Ptr(value[1:]) | ||||||
| 			if err != nil { |  | ||||||
| 				return err |  | ||||||
| 			} |  | ||||||
| 			v.Value = langext.Ptr(r.Value.(string)) |  | ||||||
| 			v.DataType = datatype | 			v.DataType = datatype | ||||||
| 			return nil | 			return nil | ||||||
| 		} | 		} | ||||||
| @@ -512,6 +537,10 @@ func (v *MetaValue) Deserialize(value string, datatype metaDataType) error { | |||||||
| 		v.Value = nil | 		v.Value = nil | ||||||
| 		v.DataType = datatype | 		v.DataType = datatype | ||||||
| 		return nil | 		return nil | ||||||
|  | 	case MDTEnum: | ||||||
|  | 		v.Value = deserializeEnumWrap(value) | ||||||
|  | 		v.DataType = datatype | ||||||
|  | 		return nil | ||||||
| 	} | 	} | ||||||
| 	return errors.New("Unknown type: " + string(datatype)) | 	return errors.New("Unknown type: " + string(datatype)) | ||||||
| } | } | ||||||
| @@ -582,53 +611,86 @@ func (v MetaValue) ValueString() string { | |||||||
| 		return string(r) | 		return string(r) | ||||||
| 	case MDTNil: | 	case MDTNil: | ||||||
| 		return "<<null>>" | 		return "<<null>>" | ||||||
|  | 	case MDTEnum: | ||||||
|  | 		return v.Value.(EnumWrap).String() | ||||||
| 	} | 	} | ||||||
| 	return "(err)" | 	return "(err)" | ||||||
| } | } | ||||||
|  |  | ||||||
| func valueFromProto(value string, datatype metaDataType) (MetaValue, error) { | // rawValueForJson returns most-of-the-time the `Value` field | ||||||
| 	obj := MetaValue{} | // but for some datatyes we do special processing | ||||||
| 	err := obj.Deserialize(value, datatype) | // all, so we can pluck the output value in json.Marshal without any suprises | ||||||
| 	if err != nil { | func (v MetaValue) rawValueForJson() any { | ||||||
| 		return MetaValue{}, err | 	if v.DataType == MDTAny { | ||||||
| 	} | 		if v.Value.(AnyWrap).IsNil { | ||||||
| 	return obj, nil | 			return nil | ||||||
| } |  | ||||||
|  |  | ||||||
| func metaFromProto(proto []*spbmodels.CustomError_MetaValue) MetaMap { |  | ||||||
| 	r := make(MetaMap) |  | ||||||
|  |  | ||||||
| 	for _, v := range proto { |  | ||||||
| 		mval, err := valueFromProto(v.Value, metaDataType(v.Type)) |  | ||||||
| 		if err != nil { |  | ||||||
| 			log.Warn().Err(err).Msg("metaFromProto failed for " + v.Key) |  | ||||||
| 			continue |  | ||||||
| 		} | 		} | ||||||
| 		r[v.Key] = mval | 		if v.Value.(AnyWrap).IsError { | ||||||
| 	} | 			return bson.M{"@error": true} | ||||||
|  | 		} | ||||||
| 	return r | 		jsonobj := primitive.M{} | ||||||
| } | 		jsonarr := primitive.A{} | ||||||
|  | 		if err := json.Unmarshal([]byte(v.Value.(AnyWrap).Json), &jsonobj); err == nil { | ||||||
| func (mm MetaMap) ToProto() []*spbmodels.CustomError_MetaValue { | 			return jsonobj | ||||||
| 	if mm == nil { | 		} else if err := json.Unmarshal([]byte(v.Value.(AnyWrap).Json), &jsonarr); err == nil { | ||||||
| 		return make([]*spbmodels.CustomError_MetaValue, 0) | 			return jsonarr | ||||||
| 	} | 		} else { | ||||||
| 	r := make([]*spbmodels.CustomError_MetaValue, 0, len(mm)) | 			return bson.M{"type": v.Value.(AnyWrap).Type, "data": v.Value.(AnyWrap).Json} | ||||||
| 	for k, v := range mm { |  | ||||||
| 		strval, err := v.SerializeValue() |  | ||||||
| 		if err != nil { |  | ||||||
| 			log.Warn().Err(err).Msg("MetaMap.ToProto failed for " + k) |  | ||||||
| 			continue |  | ||||||
| 		} | 		} | ||||||
|  |  | ||||||
| 		r = append(r, &spbmodels.CustomError_MetaValue{ |  | ||||||
| 			Key:   k, |  | ||||||
| 			Type:  string(v.DataType), |  | ||||||
| 			Value: strval, |  | ||||||
| 		}) |  | ||||||
| 	} | 	} | ||||||
| 	return r | 	if v.DataType == MDTID { | ||||||
|  | 		if v.Value.(IDWrap).IsNil { | ||||||
|  | 			return nil | ||||||
|  | 		} | ||||||
|  | 		return v.Value.(IDWrap).Value | ||||||
|  | 	} | ||||||
|  | 	if v.DataType == MDTBytes { | ||||||
|  | 		return hex.EncodeToString(v.Value.([]byte)) | ||||||
|  | 	} | ||||||
|  | 	if v.DataType == MDTDuration { | ||||||
|  | 		return v.Value.(time.Duration).String() | ||||||
|  | 	} | ||||||
|  | 	if v.DataType == MDTTime { | ||||||
|  | 		return v.Value.(time.Time).Format(time.RFC3339Nano) | ||||||
|  | 	} | ||||||
|  | 	if v.DataType == MDTObjectID { | ||||||
|  | 		return v.Value.(primitive.ObjectID).Hex() | ||||||
|  | 	} | ||||||
|  | 	if v.DataType == MDTNil { | ||||||
|  | 		return nil | ||||||
|  | 	} | ||||||
|  | 	if v.DataType == MDTEnum { | ||||||
|  | 		if v.Value.(EnumWrap).IsNil { | ||||||
|  | 			return nil | ||||||
|  | 		} | ||||||
|  | 		if v.Value.(EnumWrap).ValueRaw != nil { | ||||||
|  | 			return v.Value.(EnumWrap).ValueRaw | ||||||
|  | 		} | ||||||
|  | 		return v.Value.(EnumWrap).ValueString | ||||||
|  | 	} | ||||||
|  | 	if v.DataType == MDTFloat32 { | ||||||
|  | 		if math.IsNaN(float64(v.Value.(float32))) { | ||||||
|  | 			return "float64::NaN" | ||||||
|  | 		} else if math.IsInf(float64(v.Value.(float32)), +1) { | ||||||
|  | 			return "float64::+inf" | ||||||
|  | 		} else if math.IsInf(float64(v.Value.(float32)), -1) { | ||||||
|  | 			return "float64::-inf" | ||||||
|  | 		} else { | ||||||
|  | 			return v.Value | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | 	if v.DataType == MDTFloat64 { | ||||||
|  | 		if math.IsNaN(v.Value.(float64)) { | ||||||
|  | 			return "float64::NaN" | ||||||
|  | 		} else if math.IsInf(v.Value.(float64), +1) { | ||||||
|  | 			return "float64::+inf" | ||||||
|  | 		} else if math.IsInf(v.Value.(float64), -1) { | ||||||
|  | 			return "float64::-inf" | ||||||
|  | 		} else { | ||||||
|  | 			return v.Value | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | 	return v.Value | ||||||
| } | } | ||||||
|  |  | ||||||
| func (mm MetaMap) FormatOneLine(singleMaxLen int) string { | func (mm MetaMap) FormatOneLine(singleMaxLen int) string { | ||||||
| @@ -658,6 +720,9 @@ func (mm MetaMap) FormatMultiLine(indentFront string, indentKeys string, maxLenV | |||||||
| 		if key == "gin.body" { | 		if key == "gin.body" { | ||||||
| 			continue | 			continue | ||||||
| 		} | 		} | ||||||
|  | 		if key == "gin_body" { | ||||||
|  | 			continue | ||||||
|  | 		} | ||||||
|  |  | ||||||
| 		r += indentFront | 		r += indentFront | ||||||
| 		r += indentKeys | 		r += indentKeys | ||||||
| @@ -675,9 +740,9 @@ func (mm MetaMap) Any() bool { | |||||||
| 	return len(mm) > 0 | 	return len(mm) > 0 | ||||||
| } | } | ||||||
|  |  | ||||||
| func (mm MetaMap) Apply(evt *zerolog.Event) *zerolog.Event { | func (mm MetaMap) Apply(evt *zerolog.Event, limitLen *int) *zerolog.Event { | ||||||
| 	for key, val := range mm { | 	for key, val := range mm { | ||||||
| 		evt = val.Apply(key, evt) | 		evt = val.Apply(key, evt, limitLen) | ||||||
| 	} | 	} | ||||||
| 	return evt | 	return evt | ||||||
| } | } | ||||||
|   | |||||||
							
								
								
									
										13
									
								
								exerr/proxy.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								exerr/proxy.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,13 @@ | |||||||
|  | package exerr | ||||||
|  |  | ||||||
|  | type Proxy struct { | ||||||
|  | 	v ExErr | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (p *Proxy) UniqueID() string { | ||||||
|  | 	return p.v.UniqueID | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (p *Proxy) Get() ExErr { | ||||||
|  | 	return p.v | ||||||
|  | } | ||||||
| @@ -4,7 +4,8 @@ import ( | |||||||
| 	"encoding/json" | 	"encoding/json" | ||||||
| 	"fmt" | 	"fmt" | ||||||
| 	"github.com/rs/zerolog/log" | 	"github.com/rs/zerolog/log" | ||||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/langext" | 	"git.blackforestbytes.com/BlackForestBytes/goext/enums" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
| 	"strings" | 	"strings" | ||||||
| ) | ) | ||||||
| 
 | 
 | ||||||
| @@ -131,3 +132,58 @@ func deserializeAnyWrap(v string) AnyWrap { | |||||||
| 		} | 		} | ||||||
| 	} | 	} | ||||||
| } | } | ||||||
|  | 
 | ||||||
|  | type EnumWrap struct { | ||||||
|  | 	Type        string | ||||||
|  | 	ValueString string | ||||||
|  | 	ValueRaw    enums.Enum // `ValueRaw` is lost during serialization roundtrip | ||||||
|  | 	IsNil       bool | ||||||
|  | } | ||||||
|  | 
 | ||||||
|  | func newEnumWrap(val enums.Enum) EnumWrap { | ||||||
|  | 	t := fmt.Sprintf("%T", val) | ||||||
|  | 	arr := strings.Split(t, ".") | ||||||
|  | 	if len(arr) > 0 { | ||||||
|  | 		t = arr[len(arr)-1] | ||||||
|  | 	} | ||||||
|  | 
 | ||||||
|  | 	if langext.IsNil(val) { | ||||||
|  | 		return EnumWrap{Type: t, ValueString: "", ValueRaw: val, IsNil: true} | ||||||
|  | 	} | ||||||
|  | 
 | ||||||
|  | 	if enumstr, ok := val.(enums.StringEnum); ok { | ||||||
|  | 		return EnumWrap{Type: t, ValueString: enumstr.String(), ValueRaw: val, IsNil: false} | ||||||
|  | 	} | ||||||
|  | 
 | ||||||
|  | 	return EnumWrap{Type: t, ValueString: fmt.Sprintf("%v", val), ValueRaw: val, IsNil: false} | ||||||
|  | } | ||||||
|  | 
 | ||||||
|  | func (w EnumWrap) Serialize() string { | ||||||
|  | 	if w.IsNil { | ||||||
|  | 		return "!nil" + ":" + w.Type | ||||||
|  | 	} | ||||||
|  | 	return w.Type + ":" + w.ValueString | ||||||
|  | } | ||||||
|  | 
 | ||||||
|  | func (w EnumWrap) String() string { | ||||||
|  | 	if w.IsNil { | ||||||
|  | 		return w.Type + "<<nil>>" | ||||||
|  | 	} | ||||||
|  | 	return "[" + w.Type + "] " + w.ValueString | ||||||
|  | } | ||||||
|  | 
 | ||||||
|  | func deserializeEnumWrap(v string) EnumWrap { | ||||||
|  | 	r := strings.SplitN(v, ":", 2) | ||||||
|  | 
 | ||||||
|  | 	if len(r) == 2 && r[0] == "!nil" { | ||||||
|  | 		return EnumWrap{Type: r[1], ValueString: v, ValueRaw: nil, IsNil: true} | ||||||
|  | 	} | ||||||
|  | 
 | ||||||
|  | 	if len(r) == 0 { | ||||||
|  | 		return EnumWrap{} | ||||||
|  | 	} else if len(r) == 1 { | ||||||
|  | 		return EnumWrap{Type: "", ValueString: v, ValueRaw: nil, IsNil: false} | ||||||
|  | 	} else { | ||||||
|  | 		return EnumWrap{Type: r[0], ValueString: r[1], ValueRaw: nil, IsNil: false} | ||||||
|  | 	} | ||||||
|  | } | ||||||
							
								
								
									
										36
									
								
								fsext/exists.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										36
									
								
								fsext/exists.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,36 @@ | |||||||
|  | package fsext | ||||||
|  |  | ||||||
|  | import "os" | ||||||
|  |  | ||||||
|  | func PathExists(fp string) (bool, error) { | ||||||
|  | 	_, err := os.Stat(fp) | ||||||
|  | 	if err == nil { | ||||||
|  | 		return true, nil | ||||||
|  | 	} | ||||||
|  | 	if os.IsNotExist(err) { | ||||||
|  | 		return false, nil | ||||||
|  | 	} | ||||||
|  | 	return false, err | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func FileExists(fp string) (bool, error) { | ||||||
|  | 	stat, err := os.Stat(fp) | ||||||
|  | 	if err == nil { | ||||||
|  | 		return !stat.IsDir(), nil | ||||||
|  | 	} | ||||||
|  | 	if os.IsNotExist(err) { | ||||||
|  | 		return false, nil | ||||||
|  | 	} | ||||||
|  | 	return false, err | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func DirectoryExists(fp string) (bool, error) { | ||||||
|  | 	stat, err := os.Stat(fp) | ||||||
|  | 	if err == nil { | ||||||
|  | 		return stat.IsDir(), nil | ||||||
|  | 	} | ||||||
|  | 	if os.IsNotExist(err) { | ||||||
|  | 		return false, nil | ||||||
|  | 	} | ||||||
|  | 	return false, err | ||||||
|  | } | ||||||
							
								
								
									
										68
									
								
								ginext/appContext.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										68
									
								
								ginext/appContext.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,68 @@ | |||||||
|  | package ginext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"context" | ||||||
|  | 	"github.com/gin-gonic/gin" | ||||||
|  | 	"time" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | type AppContext struct { | ||||||
|  | 	inner      context.Context | ||||||
|  | 	cancelFunc context.CancelFunc | ||||||
|  | 	cancelled  bool | ||||||
|  | 	GinContext *gin.Context | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func CreateAppContext(g *gin.Context, innerCtx context.Context, cancelFn context.CancelFunc) *AppContext { | ||||||
|  | 	for key, value := range g.Keys { | ||||||
|  | 		innerCtx = context.WithValue(innerCtx, key, value) | ||||||
|  | 	} | ||||||
|  | 	return &AppContext{ | ||||||
|  | 		inner:      innerCtx, | ||||||
|  | 		cancelFunc: cancelFn, | ||||||
|  | 		cancelled:  false, | ||||||
|  | 		GinContext: g, | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func CreateBackgroundAppContext() *AppContext { | ||||||
|  | 	return &AppContext{ | ||||||
|  | 		inner:      context.Background(), | ||||||
|  | 		cancelFunc: nil, | ||||||
|  | 		cancelled:  false, | ||||||
|  | 		GinContext: nil, | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ac *AppContext) Deadline() (deadline time.Time, ok bool) { | ||||||
|  | 	return ac.inner.Deadline() | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ac *AppContext) Done() <-chan struct{} { | ||||||
|  | 	return ac.inner.Done() | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ac *AppContext) Err() error { | ||||||
|  | 	return ac.inner.Err() | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ac *AppContext) Value(key any) any { | ||||||
|  | 	return ac.inner.Value(key) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ac *AppContext) Set(key, value any) { | ||||||
|  | 	ac.inner = context.WithValue(ac.inner, key, value) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ac *AppContext) Cancel() { | ||||||
|  | 	ac.cancelled = true | ||||||
|  | 	ac.cancelFunc() | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (ac *AppContext) RequestURI() string { | ||||||
|  | 	if ac.GinContext != nil && ac.GinContext.Request != nil { | ||||||
|  | 		return ac.GinContext.Request.Method + " :: " + ac.GinContext.Request.RequestURI | ||||||
|  | 	} else { | ||||||
|  | 		return "" | ||||||
|  | 	} | ||||||
|  | } | ||||||
							
								
								
									
										23
									
								
								ginext/commonHandler.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										23
									
								
								ginext/commonHandler.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,23 @@ | |||||||
|  | package ginext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"net/http" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | func RedirectFound(newuri string) WHandlerFunc { | ||||||
|  | 	return func(pctx PreContext) HTTPResponse { | ||||||
|  | 		return Redirect(http.StatusFound, newuri) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func RedirectTemporary(newuri string) WHandlerFunc { | ||||||
|  | 	return func(pctx PreContext) HTTPResponse { | ||||||
|  | 		return Redirect(http.StatusTemporaryRedirect, newuri) | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func RedirectPermanent(newuri string) WHandlerFunc { | ||||||
|  | 	return func(pctx PreContext) HTTPResponse { | ||||||
|  | 		return Redirect(http.StatusPermanentRedirect, newuri) | ||||||
|  | 	} | ||||||
|  | } | ||||||
							
								
								
									
										12
									
								
								ginext/commonMiddlewares.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										12
									
								
								ginext/commonMiddlewares.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,12 @@ | |||||||
|  | package ginext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"github.com/gin-gonic/gin" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/dataext" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | func BodyBuffer(g *gin.Context) { | ||||||
|  | 	if g.Request.Body != nil { | ||||||
|  | 		g.Request.Body = dataext.NewBufferedReadCloser(g.Request.Body) | ||||||
|  | 	} | ||||||
|  | } | ||||||
							
								
								
									
										25
									
								
								ginext/cors.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										25
									
								
								ginext/cors.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,25 @@ | |||||||
|  | package ginext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"github.com/gin-gonic/gin" | ||||||
|  | 	"net/http" | ||||||
|  | 	"strings" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | func CorsMiddleware(allowheader []string, exposeheader []string) gin.HandlerFunc { | ||||||
|  | 	return func(c *gin.Context) { | ||||||
|  | 		c.Writer.Header().Set("Access-Control-Allow-Origin", "*") | ||||||
|  | 		c.Writer.Header().Set("Access-Control-Allow-Credentials", "true") | ||||||
|  | 		c.Writer.Header().Set("Access-Control-Allow-Headers", strings.Join(allowheader, ", ")) | ||||||
|  | 		if len(exposeheader) > 0 { | ||||||
|  | 			c.Writer.Header().Set("Access-Control-Expose-Headers", strings.Join(exposeheader, ", ")) | ||||||
|  | 		} | ||||||
|  | 		c.Writer.Header().Set("Access-Control-Allow-Methods", "OPTIONS, GET, POST, PUT, PATCH, DELETE, COUNT") | ||||||
|  |  | ||||||
|  | 		if c.Request.Method == "OPTIONS" { | ||||||
|  | 			c.AbortWithStatus(http.StatusOK) | ||||||
|  | 		} else { | ||||||
|  | 			c.Next() | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | } | ||||||
							
								
								
									
										238
									
								
								ginext/engine.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										238
									
								
								ginext/engine.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,238 @@ | |||||||
|  | package ginext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"fmt" | ||||||
|  | 	"github.com/gin-gonic/gin" | ||||||
|  | 	"github.com/rs/zerolog/log" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/mathext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/rext" | ||||||
|  | 	"net" | ||||||
|  | 	"net/http" | ||||||
|  | 	"net/http/httptest" | ||||||
|  | 	"regexp" | ||||||
|  | 	"strings" | ||||||
|  | 	"time" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | type GinWrapper struct { | ||||||
|  | 	engine          *gin.Engine | ||||||
|  | 	suppressGinLogs bool | ||||||
|  |  | ||||||
|  | 	opt                   Options | ||||||
|  | 	allowCors             bool | ||||||
|  | 	corsAllowHeader       []string | ||||||
|  | 	corsExposeHeader      []string | ||||||
|  | 	ginDebug              bool | ||||||
|  | 	bufferBody            bool | ||||||
|  | 	requestTimeout        time.Duration | ||||||
|  | 	listenerBeforeRequest []func(g *gin.Context) | ||||||
|  | 	listenerAfterRequest  []func(g *gin.Context, resp HTTPResponse) | ||||||
|  |  | ||||||
|  | 	buildRequestBindError func(g *gin.Context, fieldtype string, err error) HTTPResponse | ||||||
|  |  | ||||||
|  | 	routeSpecs []ginRouteSpec | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type ginRouteSpec struct { | ||||||
|  | 	Method      string | ||||||
|  | 	URL         string | ||||||
|  | 	Middlewares []string | ||||||
|  | 	Handler     string | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type Options struct { | ||||||
|  | 	AllowCors                *bool                                                          // Add cors handler to allow all CORS requests on the default http methods | ||||||
|  | 	CorsAllowHeader          *[]string                                                      // override the default values of Access-Control-Allow-Headers (AllowCors must be true) | ||||||
|  | 	CorsExposeHeader         *[]string                                                      // return Access-Control-Expose-Headers (AllowCors must be true) | ||||||
|  | 	GinDebug                 *bool                                                          // Set gin.debug to true (adds more logs) | ||||||
|  | 	SuppressGinLogs          *bool                                                          // Suppress our custom gin logs (even if GinDebug == true) | ||||||
|  | 	BufferBody               *bool                                                          // Buffers the input body stream, this way the ginext error handler can later include the whole request body | ||||||
|  | 	Timeout                  *time.Duration                                                 // The default handler timeout | ||||||
|  | 	ListenerBeforeRequest    []func(g *gin.Context)                                         // Register listener that are called before the handler method | ||||||
|  | 	ListenerAfterRequest     []func(g *gin.Context, resp HTTPResponse)                      // Register listener that are called after the handler method | ||||||
|  | 	DebugTrimHandlerPrefixes []string                                                       // Trim these prefixes from the handler names in the debug print | ||||||
|  | 	DebugReplaceHandlerNames map[string]string                                              // Replace handler names in debug output | ||||||
|  | 	BuildRequestBindError    func(g *gin.Context, fieldtype string, err error) HTTPResponse // Override function which generates the HTTPResponse errors that are returned by the preContext..Start() methids | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // NewEngine creates a new (wrapped) ginEngine | ||||||
|  | func NewEngine(opt Options) *GinWrapper { | ||||||
|  | 	ginDebug := langext.Coalesce(opt.GinDebug, true) | ||||||
|  | 	if ginDebug { | ||||||
|  | 		gin.SetMode(gin.DebugMode) | ||||||
|  |  | ||||||
|  | 		// do not debug-print routes | ||||||
|  | 		gin.DebugPrintRouteFunc = func(_, _, _ string, _ int) {} | ||||||
|  |  | ||||||
|  | 	} else { | ||||||
|  | 		gin.SetMode(gin.ReleaseMode) | ||||||
|  |  | ||||||
|  | 		// do not debug-print routes | ||||||
|  | 		gin.DebugPrintRouteFunc = func(_, _, _ string, _ int) {} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	engine := gin.New() | ||||||
|  |  | ||||||
|  | 	wrapper := &GinWrapper{ | ||||||
|  | 		engine:                engine, | ||||||
|  | 		opt:                   opt, | ||||||
|  | 		suppressGinLogs:       langext.Coalesce(opt.SuppressGinLogs, false), | ||||||
|  | 		allowCors:             langext.Coalesce(opt.AllowCors, false), | ||||||
|  | 		corsAllowHeader:       langext.Coalesce(opt.CorsAllowHeader, []string{"Content-Type", "Content-Length", "Accept-Encoding", "X-CSRF-Token", "Authorization", "accept", "origin", "Cache-Control", "X-Requested-With"}), | ||||||
|  | 		corsExposeHeader:      langext.Coalesce(opt.CorsExposeHeader, []string{}), | ||||||
|  | 		ginDebug:              ginDebug, | ||||||
|  | 		bufferBody:            langext.Coalesce(opt.BufferBody, false), | ||||||
|  | 		requestTimeout:        langext.Coalesce(opt.Timeout, 24*time.Hour), | ||||||
|  | 		listenerBeforeRequest: opt.ListenerBeforeRequest, | ||||||
|  | 		listenerAfterRequest:  opt.ListenerAfterRequest, | ||||||
|  | 		buildRequestBindError: langext.Conditional(opt.BuildRequestBindError == nil, defaultBuildRequestBindError, opt.BuildRequestBindError), | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	engine.RedirectFixedPath = false | ||||||
|  | 	engine.RedirectTrailingSlash = false | ||||||
|  |  | ||||||
|  | 	if wrapper.allowCors { | ||||||
|  | 		engine.Use(CorsMiddleware(wrapper.corsAllowHeader, wrapper.corsExposeHeader)) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if ginDebug && !wrapper.suppressGinLogs { | ||||||
|  | 		ginlogger := gin.Logger() | ||||||
|  | 		engine.Use(func(context *gin.Context) { ginlogger(context) }) | ||||||
|  | 	} | ||||||
|  | 	return wrapper | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (w *GinWrapper) ListenAndServeHTTP(addr string, postInit func(port string)) (chan error, *http.Server) { | ||||||
|  |  | ||||||
|  | 	w.DebugPrintRoutes() | ||||||
|  |  | ||||||
|  | 	httpserver := &http.Server{ | ||||||
|  | 		Addr:    addr, | ||||||
|  | 		Handler: w.engine, | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	errChan := make(chan error) | ||||||
|  |  | ||||||
|  | 	go func() { | ||||||
|  |  | ||||||
|  | 		ln, err := net.Listen("tcp", httpserver.Addr) | ||||||
|  | 		if err != nil { | ||||||
|  | 			errChan <- err | ||||||
|  | 			return | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		_, port, err := net.SplitHostPort(ln.Addr().String()) | ||||||
|  | 		if err != nil { | ||||||
|  | 			errChan <- err | ||||||
|  | 			return | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		log.Info().Str("address", httpserver.Addr).Msg("HTTP-Server started on http://localhost:" + port) | ||||||
|  |  | ||||||
|  | 		if postInit != nil { | ||||||
|  | 			postInit(port) // the net.Listener a few lines above is at this point actually already buffering requests | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		errChan <- httpserver.Serve(ln) | ||||||
|  | 	}() | ||||||
|  |  | ||||||
|  | 	return errChan, httpserver | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (w *GinWrapper) DebugPrintRoutes() { | ||||||
|  | 	if !w.ginDebug { | ||||||
|  | 		return | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	lines := make([][4]string, 0) | ||||||
|  |  | ||||||
|  | 	pad := [4]int{0, 0, 0, 0} | ||||||
|  |  | ||||||
|  | 	for _, spec := range w.routeSpecs { | ||||||
|  |  | ||||||
|  | 		line := [4]string{ | ||||||
|  | 			spec.Method, | ||||||
|  | 			spec.URL, | ||||||
|  | 			strings.Join(langext.ArrMap(spec.Middlewares, w.cleanMiddlewareName), " -> "), | ||||||
|  | 			w.cleanMiddlewareName(spec.Handler), | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		lines = append(lines, line) | ||||||
|  |  | ||||||
|  | 		pad[0] = mathext.Max(pad[0], len(line[0])) | ||||||
|  | 		pad[1] = mathext.Max(pad[1], len(line[1])) | ||||||
|  | 		pad[2] = mathext.Max(pad[2], len(line[2])) | ||||||
|  | 		pad[3] = mathext.Max(pad[3], len(line[3])) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	fmt.Printf("Gin-Routes:\n") | ||||||
|  | 	fmt.Printf("{\n") | ||||||
|  | 	for _, line := range lines { | ||||||
|  |  | ||||||
|  | 		fmt.Printf(" %s  %s  -->  %s  -->  %s\n", | ||||||
|  | 			langext.StrPadRight("["+line[0]+"]", " ", pad[0]+2), | ||||||
|  | 			langext.StrPadRight(line[1], " ", pad[1]), | ||||||
|  | 			langext.StrPadRight(line[2], " ", pad[2]), | ||||||
|  | 			langext.StrPadRight(line[3], " ", pad[3])) | ||||||
|  | 	} | ||||||
|  | 	fmt.Printf("}\n") | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (w *GinWrapper) cleanMiddlewareName(fname string) string { | ||||||
|  |  | ||||||
|  | 	funcSuffix := rext.W(regexp.MustCompile(`\.func[0-9]+(?:\.[0-9]+)*$`)) | ||||||
|  | 	if match, ok := funcSuffix.MatchFirst(fname); ok { | ||||||
|  | 		fname = fname[:len(fname)-match.FullMatch().Length()] | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if strings.HasSuffix(fname, ".(*GinRoutesWrapper).WithJSONFilter") { | ||||||
|  | 		fname = "[JSONFilter]" | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if fname == "ginext.BodyBuffer" { | ||||||
|  | 		fname = "[BodyBuffer]" | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	skipPrefixes := []string{"api.(*Handler).", "api.", "ginext.", "handler.", "admin-app.", "employee-app.", "employer-app."} | ||||||
|  | 	for _, pfx := range skipPrefixes { | ||||||
|  | 		if strings.HasPrefix(fname, pfx) { | ||||||
|  | 			fname = fname[len(pfx):] | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	for _, pfx := range w.opt.DebugTrimHandlerPrefixes { | ||||||
|  | 		if strings.HasPrefix(fname, pfx) { | ||||||
|  | 			fname = fname[len(pfx):] | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	for k, v := range langext.ForceMap(w.opt.DebugReplaceHandlerNames) { | ||||||
|  | 		if strings.EqualFold(fname, k) { | ||||||
|  | 			fname = v | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return fname | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // ServeHTTP only used for unit tests | ||||||
|  | func (w *GinWrapper) ServeHTTP(req *http.Request) *httptest.ResponseRecorder { | ||||||
|  | 	respRec := httptest.NewRecorder() | ||||||
|  | 	w.engine.ServeHTTP(respRec, req) | ||||||
|  | 	return respRec | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // ForwardRequest manually inserts a request into this router | ||||||
|  | // = behaves as if the request came from the outside (and writes the response to `writer`) | ||||||
|  | func (w *GinWrapper) ForwardRequest(writer http.ResponseWriter, req *http.Request) { | ||||||
|  | 	w.engine.ServeHTTP(writer, req) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (w *GinWrapper) ListRoutes() []gin.RouteInfo { | ||||||
|  | 	return w.engine.Routes() | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func defaultBuildRequestBindError(g *gin.Context, fieldtype string, err error) HTTPResponse { | ||||||
|  | 	return Error(err) | ||||||
|  | } | ||||||
							
								
								
									
										89
									
								
								ginext/funcWrapper.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										89
									
								
								ginext/funcWrapper.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,89 @@ | |||||||
|  | package ginext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"fmt" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/exerr" | ||||||
|  | 	"github.com/gin-gonic/gin" | ||||||
|  | 	"net/http" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | type WHandlerFunc func(PreContext) HTTPResponse | ||||||
|  |  | ||||||
|  | func Wrap(w *GinWrapper, fn WHandlerFunc) gin.HandlerFunc { | ||||||
|  |  | ||||||
|  | 	return func(g *gin.Context) { | ||||||
|  |  | ||||||
|  | 		reqctx := g.Request.Context() | ||||||
|  |  | ||||||
|  | 		pctx := PreContext{ | ||||||
|  | 			wrapper:        w, | ||||||
|  | 			ginCtx:         g, | ||||||
|  | 			persistantData: &preContextData{}, | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		for _, lstr := range w.listenerBeforeRequest { | ||||||
|  | 			lstr(g) | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		wrap, stackTrace, panicObj := callPanicSafe(fn, pctx) | ||||||
|  | 		if panicObj != nil { | ||||||
|  |  | ||||||
|  | 			fmt.Printf("\n======== ======== STACKTRACE ======== ========\n%s\n======== ======== ======== ========\n\n", stackTrace) | ||||||
|  |  | ||||||
|  | 			err := exerr. | ||||||
|  | 				New(exerr.TypePanic, "Panic occured (in gin handler)"). | ||||||
|  | 				Any("panicObj", panicObj). | ||||||
|  | 				Str("trace", stackTrace). | ||||||
|  | 				Build() | ||||||
|  |  | ||||||
|  | 			wrap = Error(err) | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		if g.Writer.Written() { | ||||||
|  | 			panic("Writing in WrapperFunc is not supported") | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		if pctx.persistantData.sessionObj != nil { | ||||||
|  | 			err := pctx.persistantData.sessionObj.Finish(reqctx, wrap) | ||||||
|  | 			if err != nil { | ||||||
|  | 				wrap = Error(exerr.Wrap(err, "Failed to finish session").Any("originalResponse", wrap).Build()) | ||||||
|  | 			} | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		for _, lstr := range w.listenerAfterRequest { | ||||||
|  | 			lstr(g, wrap) | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		if reqctx.Err() == nil { | ||||||
|  | 			wrap.Write(g) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func WrapHTTPHandler(w *GinWrapper, fn http.Handler) gin.HandlerFunc { | ||||||
|  | 	return func(g *gin.Context) { | ||||||
|  | 		for _, lstr := range w.listenerBeforeRequest { | ||||||
|  | 			lstr(g) | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		fn.ServeHTTP(g.Writer, g.Request) | ||||||
|  |  | ||||||
|  | 		for _, lstr := range w.listenerAfterRequest { | ||||||
|  | 			lstr(g, nil) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func WrapHTTPHandlerFunc(w *GinWrapper, fn http.HandlerFunc) gin.HandlerFunc { | ||||||
|  | 	return func(g *gin.Context) { | ||||||
|  | 		for _, lstr := range w.listenerBeforeRequest { | ||||||
|  | 			lstr(g) | ||||||
|  | 		} | ||||||
|  |  | ||||||
|  | 		fn(g.Writer, g.Request) | ||||||
|  |  | ||||||
|  | 		for _, lstr := range w.listenerAfterRequest { | ||||||
|  | 			lstr(g, nil) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | } | ||||||
							
								
								
									
										9
									
								
								ginext/jsonFilter.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										9
									
								
								ginext/jsonFilter.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,9 @@ | |||||||
|  | package ginext | ||||||
|  |  | ||||||
|  | import "github.com/gin-gonic/gin" | ||||||
|  |  | ||||||
|  | var jsonFilterKey = "goext.jsonfilter" | ||||||
|  |  | ||||||
|  | func SetJSONFilter(g *gin.Context, filter string) { | ||||||
|  | 	g.Set(jsonFilterKey, filter) | ||||||
|  | } | ||||||
							
								
								
									
										211
									
								
								ginext/preContext.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										211
									
								
								ginext/preContext.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,211 @@ | |||||||
|  | package ginext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"bytes" | ||||||
|  | 	"context" | ||||||
|  | 	"fmt" | ||||||
|  | 	"github.com/gin-gonic/gin" | ||||||
|  | 	"github.com/gin-gonic/gin/binding" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/dataext" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/exerr" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | 	"io" | ||||||
|  | 	"runtime/debug" | ||||||
|  | 	"time" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | type PreContext struct { | ||||||
|  | 	ginCtx                 *gin.Context | ||||||
|  | 	wrapper                *GinWrapper | ||||||
|  | 	uri                    any | ||||||
|  | 	query                  any | ||||||
|  | 	body                   any | ||||||
|  | 	rawbody                *[]byte | ||||||
|  | 	form                   any | ||||||
|  | 	header                 any | ||||||
|  | 	timeout                *time.Duration | ||||||
|  | 	persistantData         *preContextData // must be a ptr, so that we can get the values back in out Wrap func | ||||||
|  | 	ignoreWrongContentType bool | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type preContextData struct { | ||||||
|  | 	sessionObj SessionObject | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (pctx *PreContext) URI(uri any) *PreContext { | ||||||
|  | 	pctx.uri = uri | ||||||
|  | 	return pctx | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (pctx *PreContext) Query(query any) *PreContext { | ||||||
|  | 	pctx.query = query | ||||||
|  | 	return pctx | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (pctx *PreContext) Body(body any) *PreContext { | ||||||
|  | 	pctx.body = body | ||||||
|  | 	return pctx | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (pctx *PreContext) RawBody(rawbody *[]byte) *PreContext { | ||||||
|  | 	pctx.rawbody = rawbody | ||||||
|  | 	return pctx | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (pctx *PreContext) Form(form any) *PreContext { | ||||||
|  | 	pctx.form = form | ||||||
|  | 	return pctx | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (pctx *PreContext) Header(header any) *PreContext { | ||||||
|  | 	pctx.header = header | ||||||
|  | 	return pctx | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (pctx *PreContext) WithTimeout(to time.Duration) *PreContext { | ||||||
|  | 	pctx.timeout = &to | ||||||
|  | 	return pctx | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (pctx *PreContext) WithSession(sessionObj SessionObject) *PreContext { | ||||||
|  | 	pctx.persistantData.sessionObj = sessionObj | ||||||
|  | 	return pctx | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (pctx *PreContext) IgnoreWrongContentType() *PreContext { | ||||||
|  | 	pctx.ignoreWrongContentType = true | ||||||
|  | 	return pctx | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (pctx PreContext) Start() (*AppContext, *gin.Context, *HTTPResponse) { | ||||||
|  | 	if pctx.uri != nil { | ||||||
|  | 		if err := pctx.ginCtx.ShouldBindUri(pctx.uri); err != nil { | ||||||
|  | 			err = exerr.Wrap(err, "Failed to read uri"). | ||||||
|  | 				WithType(exerr.TypeBindFailURI). | ||||||
|  | 				Str("struct_type", fmt.Sprintf("%T", pctx.uri)). | ||||||
|  | 				Build() | ||||||
|  | 			return CreateBackgroundAppContext(), nil, langext.Ptr(pctx.wrapper.buildRequestBindError(pctx.ginCtx, "URI", err)) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if pctx.query != nil { | ||||||
|  | 		if err := pctx.ginCtx.ShouldBindQuery(pctx.query); err != nil { | ||||||
|  | 			err = exerr.Wrap(err, "Failed to read query"). | ||||||
|  | 				WithType(exerr.TypeBindFailQuery). | ||||||
|  | 				Str("struct_type", fmt.Sprintf("%T", pctx.query)). | ||||||
|  | 				Build() | ||||||
|  | 			return CreateBackgroundAppContext(), nil, langext.Ptr(pctx.wrapper.buildRequestBindError(pctx.ginCtx, "QUERY", err)) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if pctx.body != nil { | ||||||
|  | 		if pctx.ginCtx.ContentType() == "application/json" { | ||||||
|  | 			if brc, ok := pctx.body.(dataext.BufferedReadCloser); ok { | ||||||
|  | 				// Ensures a fully reset (offset=0) buffer before parsing | ||||||
|  | 				err := brc.Reset() | ||||||
|  | 				if err != nil { | ||||||
|  | 					err = exerr.Wrap(err, "Failed to read (brc.reset) json-body"). | ||||||
|  | 						WithType(exerr.TypeBindFailJSON). | ||||||
|  | 						Str("struct_type", fmt.Sprintf("%T", pctx.body)). | ||||||
|  | 						Build() | ||||||
|  | 					return CreateBackgroundAppContext(), nil, langext.Ptr(pctx.wrapper.buildRequestBindError(pctx.ginCtx, "JSON", err)) | ||||||
|  | 				} | ||||||
|  | 			} | ||||||
|  | 			if err := pctx.ginCtx.ShouldBindJSON(pctx.body); err != nil { | ||||||
|  | 				err = exerr.Wrap(err, "Failed to read json-body"). | ||||||
|  | 					WithType(exerr.TypeBindFailJSON). | ||||||
|  | 					Str("struct_type", fmt.Sprintf("%T", pctx.body)). | ||||||
|  | 					Build() | ||||||
|  | 				return CreateBackgroundAppContext(), nil, langext.Ptr(pctx.wrapper.buildRequestBindError(pctx.ginCtx, "JSON", err)) | ||||||
|  | 			} | ||||||
|  | 		} else { | ||||||
|  | 			if !pctx.ignoreWrongContentType { | ||||||
|  | 				err := exerr.New(exerr.TypeBindFailJSON, "missing JSON body"). | ||||||
|  | 					Str("struct_type", fmt.Sprintf("%T", pctx.body)). | ||||||
|  | 					Build() | ||||||
|  | 				return CreateBackgroundAppContext(), nil, langext.Ptr(pctx.wrapper.buildRequestBindError(pctx.ginCtx, "JSON", err)) | ||||||
|  | 			} | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if pctx.rawbody != nil { | ||||||
|  | 		if brc, ok := pctx.ginCtx.Request.Body.(dataext.BufferedReadCloser); ok { | ||||||
|  | 			v, err := brc.BufferedAll() | ||||||
|  | 			if err != nil { | ||||||
|  | 				return CreateBackgroundAppContext(), nil, langext.Ptr(pctx.wrapper.buildRequestBindError(pctx.ginCtx, "BODY", err)) | ||||||
|  | 			} | ||||||
|  | 			*pctx.rawbody = v | ||||||
|  | 		} else { | ||||||
|  | 			buf := &bytes.Buffer{} | ||||||
|  | 			_, err := io.Copy(buf, pctx.ginCtx.Request.Body) | ||||||
|  | 			if err != nil { | ||||||
|  | 				return CreateBackgroundAppContext(), nil, langext.Ptr(pctx.wrapper.buildRequestBindError(pctx.ginCtx, "BODY", err)) | ||||||
|  | 			} | ||||||
|  | 			*pctx.rawbody = buf.Bytes() | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if pctx.form != nil { | ||||||
|  | 		if pctx.ginCtx.ContentType() == "multipart/form-data" { | ||||||
|  | 			if err := pctx.ginCtx.ShouldBindWith(pctx.form, binding.Form); err != nil { | ||||||
|  | 				err = exerr.Wrap(err, "Failed to read multipart-form"). | ||||||
|  | 					WithType(exerr.TypeBindFailFormData). | ||||||
|  | 					Str("struct_type", fmt.Sprintf("%T", pctx.form)). | ||||||
|  | 					Build() | ||||||
|  | 				return CreateBackgroundAppContext(), nil, langext.Ptr(pctx.wrapper.buildRequestBindError(pctx.ginCtx, "FORM", err)) | ||||||
|  | 			} | ||||||
|  | 		} else if pctx.ginCtx.ContentType() == "application/x-www-form-urlencoded" { | ||||||
|  | 			if err := pctx.ginCtx.ShouldBindWith(pctx.form, binding.Form); err != nil { | ||||||
|  | 				err = exerr.Wrap(err, "Failed to read urlencoded-form"). | ||||||
|  | 					WithType(exerr.TypeBindFailFormData). | ||||||
|  | 					Str("struct_type", fmt.Sprintf("%T", pctx.form)). | ||||||
|  | 					Build() | ||||||
|  | 				return CreateBackgroundAppContext(), nil, langext.Ptr(pctx.wrapper.buildRequestBindError(pctx.ginCtx, "FORM", err)) | ||||||
|  | 			} | ||||||
|  | 		} else { | ||||||
|  | 			if !pctx.ignoreWrongContentType { | ||||||
|  | 				err := exerr.New(exerr.TypeBindFailFormData, "missing form body"). | ||||||
|  | 					Str("struct_type", fmt.Sprintf("%T", pctx.form)). | ||||||
|  | 					Build() | ||||||
|  | 				return CreateBackgroundAppContext(), nil, langext.Ptr(pctx.wrapper.buildRequestBindError(pctx.ginCtx, "FORM", err)) | ||||||
|  | 			} | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	if pctx.header != nil { | ||||||
|  | 		if err := pctx.ginCtx.ShouldBindHeader(pctx.header); err != nil { | ||||||
|  | 			err = exerr.Wrap(err, "Failed to read header"). | ||||||
|  | 				WithType(exerr.TypeBindFailHeader). | ||||||
|  | 				Str("struct_type", fmt.Sprintf("%T", pctx.query)). | ||||||
|  | 				Build() | ||||||
|  | 			return CreateBackgroundAppContext(), nil, langext.Ptr(pctx.wrapper.buildRequestBindError(pctx.ginCtx, "HEADER", err)) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	ictx, cancel := context.WithTimeout(context.Background(), langext.Coalesce(pctx.timeout, pctx.wrapper.requestTimeout)) | ||||||
|  |  | ||||||
|  | 	actx := CreateAppContext(pctx.ginCtx, ictx, cancel) | ||||||
|  |  | ||||||
|  | 	if pctx.persistantData.sessionObj != nil { | ||||||
|  | 		err := pctx.persistantData.sessionObj.Init(pctx.ginCtx, actx) | ||||||
|  | 		if err != nil { | ||||||
|  | 			actx.Cancel() | ||||||
|  | 			return CreateBackgroundAppContext(), nil, langext.Ptr(pctx.wrapper.buildRequestBindError(pctx.ginCtx, "INIT", err)) | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return actx, pctx.ginCtx, nil | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func callPanicSafe(fn WHandlerFunc, pctx PreContext) (res HTTPResponse, stackTrace string, panicObj any) { | ||||||
|  | 	defer func() { | ||||||
|  | 		if rec := recover(); rec != nil { | ||||||
|  | 			res = nil | ||||||
|  | 			stackTrace = string(debug.Stack()) | ||||||
|  | 			panicObj = rec | ||||||
|  | 		} | ||||||
|  | 	}() | ||||||
|  |  | ||||||
|  | 	res = fn(pctx) | ||||||
|  | 	return res, "", nil | ||||||
|  | } | ||||||
							
								
								
									
										47
									
								
								ginext/response.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										47
									
								
								ginext/response.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,47 @@ | |||||||
|  | package ginext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"github.com/gin-gonic/gin" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/exerr" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | type cookieval struct { | ||||||
|  | 	name     string | ||||||
|  | 	value    string | ||||||
|  | 	maxAge   int | ||||||
|  | 	path     string | ||||||
|  | 	domain   string | ||||||
|  | 	secure   bool | ||||||
|  | 	httpOnly bool | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type headerval struct { | ||||||
|  | 	Key string | ||||||
|  | 	Val string | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type HTTPResponse interface { | ||||||
|  | 	Write(g *gin.Context) | ||||||
|  | 	WithHeader(k string, v string) HTTPResponse | ||||||
|  | 	WithCookie(name string, value string, maxAge int, path string, domain string, secure bool, httpOnly bool) HTTPResponse | ||||||
|  | 	IsSuccess() bool | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type InspectableHTTPResponse interface { | ||||||
|  | 	HTTPResponse | ||||||
|  |  | ||||||
|  | 	Statuscode() int | ||||||
|  | 	BodyString(g *gin.Context) *string | ||||||
|  | 	ContentType() string | ||||||
|  | 	Headers() []string | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type HTTPErrorResponse interface { | ||||||
|  | 	HTTPResponse | ||||||
|  |  | ||||||
|  | 	Error() error | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func NotImplemented() HTTPResponse { | ||||||
|  | 	return Error(exerr.New(exerr.TypeNotImplemented, "").Build()) | ||||||
|  | } | ||||||
							
								
								
									
										58
									
								
								ginext/responseData.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										58
									
								
								ginext/responseData.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,58 @@ | |||||||
|  | package ginext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"github.com/gin-gonic/gin" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | type dataHTTPResponse struct { | ||||||
|  | 	statusCode  int | ||||||
|  | 	data        []byte | ||||||
|  | 	contentType string | ||||||
|  | 	headers     []headerval | ||||||
|  | 	cookies     []cookieval | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j dataHTTPResponse) Write(g *gin.Context) { | ||||||
|  | 	for _, v := range j.headers { | ||||||
|  | 		g.Header(v.Key, v.Val) | ||||||
|  | 	} | ||||||
|  | 	for _, v := range j.cookies { | ||||||
|  | 		g.SetCookie(v.name, v.value, v.maxAge, v.path, v.domain, v.secure, v.httpOnly) | ||||||
|  | 	} | ||||||
|  | 	g.Data(j.statusCode, j.contentType, j.data) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j dataHTTPResponse) WithHeader(k string, v string) HTTPResponse { | ||||||
|  | 	j.headers = append(j.headers, headerval{k, v}) | ||||||
|  | 	return j | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j dataHTTPResponse) WithCookie(name string, value string, maxAge int, path string, domain string, secure bool, httpOnly bool) HTTPResponse { | ||||||
|  | 	j.cookies = append(j.cookies, cookieval{name, value, maxAge, path, domain, secure, httpOnly}) | ||||||
|  | 	return j | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j dataHTTPResponse) IsSuccess() bool { | ||||||
|  | 	return j.statusCode >= 200 && j.statusCode <= 399 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j dataHTTPResponse) Statuscode() int { | ||||||
|  | 	return j.statusCode | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j dataHTTPResponse) BodyString(*gin.Context) *string { | ||||||
|  | 	return langext.Ptr(string(j.data)) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j dataHTTPResponse) ContentType() string { | ||||||
|  | 	return j.contentType | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j dataHTTPResponse) Headers() []string { | ||||||
|  | 	return langext.ArrMap(j.headers, func(v headerval) string { return v.Key + "=" + v.Val }) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func Data(sc int, contentType string, data []byte) HTTPResponse { | ||||||
|  | 	return &dataHTTPResponse{statusCode: sc, contentType: contentType, data: data} | ||||||
|  | } | ||||||
							
								
								
									
										64
									
								
								ginext/responseDownload.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										64
									
								
								ginext/responseDownload.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,64 @@ | |||||||
|  | package ginext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"fmt" | ||||||
|  | 	"github.com/gin-gonic/gin" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | type downloadDataHTTPResponse struct { | ||||||
|  | 	statusCode int | ||||||
|  | 	mimetype   string | ||||||
|  | 	data       []byte | ||||||
|  | 	filename   *string | ||||||
|  | 	headers    []headerval | ||||||
|  | 	cookies    []cookieval | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j downloadDataHTTPResponse) Write(g *gin.Context) { | ||||||
|  | 	g.Header("Content-Type", j.mimetype) // if we don't set it here gin does weird file-sniffing later... | ||||||
|  | 	if j.filename != nil { | ||||||
|  | 		g.Header("Content-Disposition", fmt.Sprintf("attachment; filename=\"%s\"", *j.filename)) | ||||||
|  | 	} | ||||||
|  | 	for _, v := range j.headers { | ||||||
|  | 		g.Header(v.Key, v.Val) | ||||||
|  | 	} | ||||||
|  | 	for _, v := range j.cookies { | ||||||
|  | 		g.SetCookie(v.name, v.value, v.maxAge, v.path, v.domain, v.secure, v.httpOnly) | ||||||
|  | 	} | ||||||
|  | 	g.Data(j.statusCode, j.mimetype, j.data) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j downloadDataHTTPResponse) WithHeader(k string, v string) HTTPResponse { | ||||||
|  | 	j.headers = append(j.headers, headerval{k, v}) | ||||||
|  | 	return j | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j downloadDataHTTPResponse) WithCookie(name string, value string, maxAge int, path string, domain string, secure bool, httpOnly bool) HTTPResponse { | ||||||
|  | 	j.cookies = append(j.cookies, cookieval{name, value, maxAge, path, domain, secure, httpOnly}) | ||||||
|  | 	return j | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j downloadDataHTTPResponse) IsSuccess() bool { | ||||||
|  | 	return j.statusCode >= 200 && j.statusCode <= 399 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j downloadDataHTTPResponse) Statuscode() int { | ||||||
|  | 	return j.statusCode | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j downloadDataHTTPResponse) BodyString(*gin.Context) *string { | ||||||
|  | 	return langext.Ptr(string(j.data)) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j downloadDataHTTPResponse) ContentType() string { | ||||||
|  | 	return j.mimetype | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j downloadDataHTTPResponse) Headers() []string { | ||||||
|  | 	return langext.ArrMap(j.headers, func(v headerval) string { return v.Key + "=" + v.Val }) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func DownloadData(status int, mimetype string, filename string, data []byte) HTTPResponse { | ||||||
|  | 	return &downloadDataHTTPResponse{statusCode: status, mimetype: mimetype, data: data, filename: &filename} | ||||||
|  | } | ||||||
							
								
								
									
										56
									
								
								ginext/responseEmpty.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										56
									
								
								ginext/responseEmpty.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,56 @@ | |||||||
|  | package ginext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"github.com/gin-gonic/gin" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | type emptyHTTPResponse struct { | ||||||
|  | 	statusCode int | ||||||
|  | 	headers    []headerval | ||||||
|  | 	cookies    []cookieval | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j emptyHTTPResponse) Write(g *gin.Context) { | ||||||
|  | 	for _, v := range j.headers { | ||||||
|  | 		g.Header(v.Key, v.Val) | ||||||
|  | 	} | ||||||
|  | 	for _, v := range j.cookies { | ||||||
|  | 		g.SetCookie(v.name, v.value, v.maxAge, v.path, v.domain, v.secure, v.httpOnly) | ||||||
|  | 	} | ||||||
|  | 	g.Status(j.statusCode) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j emptyHTTPResponse) WithHeader(k string, v string) HTTPResponse { | ||||||
|  | 	j.headers = append(j.headers, headerval{k, v}) | ||||||
|  | 	return j | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j emptyHTTPResponse) WithCookie(name string, value string, maxAge int, path string, domain string, secure bool, httpOnly bool) HTTPResponse { | ||||||
|  | 	j.cookies = append(j.cookies, cookieval{name, value, maxAge, path, domain, secure, httpOnly}) | ||||||
|  | 	return j | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j emptyHTTPResponse) IsSuccess() bool { | ||||||
|  | 	return j.statusCode >= 200 && j.statusCode <= 399 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j emptyHTTPResponse) Statuscode() int { | ||||||
|  | 	return j.statusCode | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j emptyHTTPResponse) BodyString(*gin.Context) *string { | ||||||
|  | 	return nil | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j emptyHTTPResponse) ContentType() string { | ||||||
|  | 	return "" | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j emptyHTTPResponse) Headers() []string { | ||||||
|  | 	return langext.ArrMap(j.headers, func(v headerval) string { return v.Key + "=" + v.Val }) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func Status(sc int) HTTPResponse { | ||||||
|  | 	return &emptyHTTPResponse{statusCode: sc} | ||||||
|  | } | ||||||
							
								
								
									
										73
									
								
								ginext/responseFile.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										73
									
								
								ginext/responseFile.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,73 @@ | |||||||
|  | package ginext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"fmt" | ||||||
|  | 	"github.com/gin-gonic/gin" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | 	"os" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | type fileHTTPResponse struct { | ||||||
|  | 	mimetype string | ||||||
|  | 	filepath string | ||||||
|  | 	filename *string | ||||||
|  | 	headers  []headerval | ||||||
|  | 	cookies  []cookieval | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j fileHTTPResponse) Write(g *gin.Context) { | ||||||
|  | 	g.Header("Content-Type", j.mimetype) // if we don't set it here gin does weird file-sniffing later... | ||||||
|  | 	if j.filename != nil { | ||||||
|  | 		g.Header("Content-Disposition", fmt.Sprintf("attachment; filename=\"%s\"", *j.filename)) | ||||||
|  |  | ||||||
|  | 	} | ||||||
|  | 	for _, v := range j.headers { | ||||||
|  | 		g.Header(v.Key, v.Val) | ||||||
|  | 	} | ||||||
|  | 	for _, v := range j.cookies { | ||||||
|  | 		g.SetCookie(v.name, v.value, v.maxAge, v.path, v.domain, v.secure, v.httpOnly) | ||||||
|  | 	} | ||||||
|  | 	g.File(j.filepath) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j fileHTTPResponse) WithHeader(k string, v string) HTTPResponse { | ||||||
|  | 	j.headers = append(j.headers, headerval{k, v}) | ||||||
|  | 	return j | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j fileHTTPResponse) WithCookie(name string, value string, maxAge int, path string, domain string, secure bool, httpOnly bool) HTTPResponse { | ||||||
|  | 	j.cookies = append(j.cookies, cookieval{name, value, maxAge, path, domain, secure, httpOnly}) | ||||||
|  | 	return j | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j fileHTTPResponse) IsSuccess() bool { | ||||||
|  | 	return true | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j fileHTTPResponse) Statuscode() int { | ||||||
|  | 	return 200 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j fileHTTPResponse) BodyString(*gin.Context) *string { | ||||||
|  | 	data, err := os.ReadFile(j.filepath) | ||||||
|  | 	if err != nil { | ||||||
|  | 		return nil | ||||||
|  | 	} | ||||||
|  | 	return langext.Ptr(string(data)) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j fileHTTPResponse) ContentType() string { | ||||||
|  | 	return j.mimetype | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j fileHTTPResponse) Headers() []string { | ||||||
|  | 	return langext.ArrMap(j.headers, func(v headerval) string { return v.Key + "=" + v.Val }) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func File(mimetype string, filepath string) HTTPResponse { | ||||||
|  | 	return &fileHTTPResponse{mimetype: mimetype, filepath: filepath} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func Download(mimetype string, filepath string, filename string) HTTPResponse { | ||||||
|  | 	return &fileHTTPResponse{mimetype: mimetype, filepath: filepath, filename: &filename} | ||||||
|  | } | ||||||
							
								
								
									
										78
									
								
								ginext/responseJson.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										78
									
								
								ginext/responseJson.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,78 @@ | |||||||
|  | package ginext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"github.com/gin-gonic/gin" | ||||||
|  | 	json "git.blackforestbytes.com/BlackForestBytes/goext/gojson" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | type jsonHTTPResponse struct { | ||||||
|  | 	statusCode     int | ||||||
|  | 	data           any | ||||||
|  | 	headers        []headerval | ||||||
|  | 	cookies        []cookieval | ||||||
|  | 	filterOverride *string | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j jsonHTTPResponse) jsonRenderer(g *gin.Context) json.GoJsonRender { | ||||||
|  | 	var f *string | ||||||
|  | 	if jsonfilter := g.GetString(jsonFilterKey); jsonfilter != "" { | ||||||
|  | 		f = &jsonfilter | ||||||
|  | 	} | ||||||
|  | 	if j.filterOverride != nil { | ||||||
|  | 		f = j.filterOverride | ||||||
|  | 	} | ||||||
|  | 	return json.GoJsonRender{Data: j.data, NilSafeSlices: true, NilSafeMaps: true, Filter: f} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j jsonHTTPResponse) Write(g *gin.Context) { | ||||||
|  | 	for _, v := range j.headers { | ||||||
|  | 		g.Header(v.Key, v.Val) | ||||||
|  | 	} | ||||||
|  | 	for _, v := range j.cookies { | ||||||
|  | 		g.SetCookie(v.name, v.value, v.maxAge, v.path, v.domain, v.secure, v.httpOnly) | ||||||
|  | 	} | ||||||
|  | 	g.Render(j.statusCode, j.jsonRenderer(g)) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j jsonHTTPResponse) WithHeader(k string, v string) HTTPResponse { | ||||||
|  | 	j.headers = append(j.headers, headerval{k, v}) | ||||||
|  | 	return j | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j jsonHTTPResponse) WithCookie(name string, value string, maxAge int, path string, domain string, secure bool, httpOnly bool) HTTPResponse { | ||||||
|  | 	j.cookies = append(j.cookies, cookieval{name, value, maxAge, path, domain, secure, httpOnly}) | ||||||
|  | 	return j | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j jsonHTTPResponse) IsSuccess() bool { | ||||||
|  | 	return j.statusCode >= 200 && j.statusCode <= 399 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j jsonHTTPResponse) Statuscode() int { | ||||||
|  | 	return j.statusCode | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j jsonHTTPResponse) BodyString(g *gin.Context) *string { | ||||||
|  | 	if str, err := j.jsonRenderer(g).RenderString(); err == nil { | ||||||
|  | 		return &str | ||||||
|  | 	} else { | ||||||
|  | 		return nil | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j jsonHTTPResponse) ContentType() string { | ||||||
|  | 	return "application/json" | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j jsonHTTPResponse) Headers() []string { | ||||||
|  | 	return langext.ArrMap(j.headers, func(v headerval) string { return v.Key + "=" + v.Val }) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func JSON(sc int, data any) HTTPResponse { | ||||||
|  | 	return &jsonHTTPResponse{statusCode: sc, data: data} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func JSONWithFilter(sc int, data any, f string) HTTPResponse { | ||||||
|  | 	return &jsonHTTPResponse{statusCode: sc, data: data, filterOverride: &f} | ||||||
|  | } | ||||||
							
								
								
									
										81
									
								
								ginext/responseJsonAPI.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										81
									
								
								ginext/responseJsonAPI.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,81 @@ | |||||||
|  | package ginext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"context" | ||||||
|  | 	"github.com/gin-gonic/gin" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/exerr" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | type jsonAPIErrResponse struct { | ||||||
|  | 	err     *exerr.ExErr | ||||||
|  | 	headers []headerval | ||||||
|  | 	cookies []cookieval | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j jsonAPIErrResponse) Error() error { | ||||||
|  | 	return j.err | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j jsonAPIErrResponse) Write(g *gin.Context) { | ||||||
|  | 	for _, v := range j.headers { | ||||||
|  | 		g.Header(v.Key, v.Val) | ||||||
|  | 	} | ||||||
|  | 	for _, v := range j.cookies { | ||||||
|  | 		g.SetCookie(v.name, v.value, v.maxAge, v.path, v.domain, v.secure, v.httpOnly) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	exerr.Get(j.err).Output(context.Background(), g) | ||||||
|  |  | ||||||
|  | 	j.err.CallListener(exerr.MethodOutput, exerr.ListenerOpt{NoLog: false}) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j jsonAPIErrResponse) WithHeader(k string, v string) HTTPResponse { | ||||||
|  | 	j.headers = append(j.headers, headerval{k, v}) | ||||||
|  | 	return j | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j jsonAPIErrResponse) WithCookie(name string, value string, maxAge int, path string, domain string, secure bool, httpOnly bool) HTTPResponse { | ||||||
|  | 	j.cookies = append(j.cookies, cookieval{name, value, maxAge, path, domain, secure, httpOnly}) | ||||||
|  | 	return j | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j jsonAPIErrResponse) IsSuccess() bool { | ||||||
|  | 	return false | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j jsonAPIErrResponse) Statuscode() int { | ||||||
|  | 	return langext.Coalesce(j.err.RecursiveStatuscode(), 0) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j jsonAPIErrResponse) BodyString(*gin.Context) *string { | ||||||
|  | 	if str, err := j.err.ToDefaultAPIJson(); err == nil { | ||||||
|  | 		return &str | ||||||
|  | 	} else { | ||||||
|  | 		return nil | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j jsonAPIErrResponse) ContentType() string { | ||||||
|  | 	return "application/json" | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j jsonAPIErrResponse) Headers() []string { | ||||||
|  | 	return langext.ArrMap(j.headers, func(v headerval) string { return v.Key + "=" + v.Val }) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j jsonAPIErrResponse) Unwrap() error { | ||||||
|  | 	return j.err | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func Error(e error) HTTPResponse { | ||||||
|  | 	return &jsonAPIErrResponse{ | ||||||
|  | 		err: exerr.FromError(e), | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func ErrWrap(e error, errorType exerr.ErrorType, msg string) HTTPResponse { | ||||||
|  | 	return &jsonAPIErrResponse{ | ||||||
|  | 		err: exerr.FromError(exerr.Wrap(e, msg).WithType(errorType).Build()), | ||||||
|  | 	} | ||||||
|  | } | ||||||
							
								
								
									
										57
									
								
								ginext/responseRedirect.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										57
									
								
								ginext/responseRedirect.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,57 @@ | |||||||
|  | package ginext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"github.com/gin-gonic/gin" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | type redirectHTTPResponse struct { | ||||||
|  | 	statusCode int | ||||||
|  | 	url        string | ||||||
|  | 	headers    []headerval | ||||||
|  | 	cookies    []cookieval | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j redirectHTTPResponse) Write(g *gin.Context) { | ||||||
|  | 	for _, v := range j.headers { | ||||||
|  | 		g.Header(v.Key, v.Val) | ||||||
|  | 	} | ||||||
|  | 	for _, v := range j.cookies { | ||||||
|  | 		g.SetCookie(v.name, v.value, v.maxAge, v.path, v.domain, v.secure, v.httpOnly) | ||||||
|  | 	} | ||||||
|  | 	g.Redirect(j.statusCode, j.url) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j redirectHTTPResponse) WithHeader(k string, v string) HTTPResponse { | ||||||
|  | 	j.headers = append(j.headers, headerval{k, v}) | ||||||
|  | 	return j | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j redirectHTTPResponse) WithCookie(name string, value string, maxAge int, path string, domain string, secure bool, httpOnly bool) HTTPResponse { | ||||||
|  | 	j.cookies = append(j.cookies, cookieval{name, value, maxAge, path, domain, secure, httpOnly}) | ||||||
|  | 	return j | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j redirectHTTPResponse) IsSuccess() bool { | ||||||
|  | 	return j.statusCode >= 200 && j.statusCode <= 399 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j redirectHTTPResponse) Statuscode() int { | ||||||
|  | 	return j.statusCode | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j redirectHTTPResponse) BodyString(*gin.Context) *string { | ||||||
|  | 	return nil | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j redirectHTTPResponse) ContentType() string { | ||||||
|  | 	return "" | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j redirectHTTPResponse) Headers() []string { | ||||||
|  | 	return langext.ArrMap(j.headers, func(v headerval) string { return v.Key + "=" + v.Val }) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func Redirect(sc int, newURL string) HTTPResponse { | ||||||
|  | 	return &redirectHTTPResponse{statusCode: sc, url: newURL} | ||||||
|  | } | ||||||
							
								
								
									
										72
									
								
								ginext/responseSeekable.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										72
									
								
								ginext/responseSeekable.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,72 @@ | |||||||
|  | package ginext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"github.com/gin-gonic/gin" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/exerr" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | 	"io" | ||||||
|  | 	"net/http" | ||||||
|  | 	"time" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | type seekableResponse struct { | ||||||
|  | 	data        io.ReadSeeker | ||||||
|  | 	contentType string | ||||||
|  | 	filename    string | ||||||
|  | 	headers     []headerval | ||||||
|  | 	cookies     []cookieval | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j seekableResponse) Write(g *gin.Context) { | ||||||
|  | 	g.Header("Content-Type", j.contentType) // if we don't set it here http.ServeContent does weird sniffing later... | ||||||
|  |  | ||||||
|  | 	for _, v := range j.headers { | ||||||
|  | 		g.Header(v.Key, v.Val) | ||||||
|  | 	} | ||||||
|  | 	for _, v := range j.cookies { | ||||||
|  | 		g.SetCookie(v.name, v.value, v.maxAge, v.path, v.domain, v.secure, v.httpOnly) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	http.ServeContent(g.Writer, g.Request, j.filename, time.Unix(0, 0), j.data) | ||||||
|  |  | ||||||
|  | 	if clsr, ok := j.data.(io.ReadSeekCloser); ok { | ||||||
|  | 		err := clsr.Close() | ||||||
|  | 		if err != nil { | ||||||
|  | 			exerr.Wrap(err, "failed to close io.ReadSeerkClose in ginext.Seekable").Str("filename", j.filename).Print() | ||||||
|  | 		} | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j seekableResponse) WithHeader(k string, v string) HTTPResponse { | ||||||
|  | 	j.headers = append(j.headers, headerval{k, v}) | ||||||
|  | 	return j | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j seekableResponse) WithCookie(name string, value string, maxAge int, path string, domain string, secure bool, httpOnly bool) HTTPResponse { | ||||||
|  | 	j.cookies = append(j.cookies, cookieval{name, value, maxAge, path, domain, secure, httpOnly}) | ||||||
|  | 	return j | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j seekableResponse) IsSuccess() bool { | ||||||
|  | 	return true | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j seekableResponse) Statuscode() int { | ||||||
|  | 	return 200 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j seekableResponse) BodyString(*gin.Context) *string { | ||||||
|  | 	return langext.Ptr("(seekable)") | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j seekableResponse) ContentType() string { | ||||||
|  | 	return j.contentType | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j seekableResponse) Headers() []string { | ||||||
|  | 	return langext.ArrMap(j.headers, func(v headerval) string { return v.Key + "=" + v.Val }) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func Seekable(filename string, contentType string, data io.ReadSeeker) HTTPResponse { | ||||||
|  | 	return &seekableResponse{filename: filename, contentType: contentType, data: data} | ||||||
|  | } | ||||||
							
								
								
									
										57
									
								
								ginext/responseText.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										57
									
								
								ginext/responseText.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,57 @@ | |||||||
|  | package ginext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"github.com/gin-gonic/gin" | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | type textHTTPResponse struct { | ||||||
|  | 	statusCode int | ||||||
|  | 	data       string | ||||||
|  | 	headers    []headerval | ||||||
|  | 	cookies    []cookieval | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j textHTTPResponse) Write(g *gin.Context) { | ||||||
|  | 	for _, v := range j.headers { | ||||||
|  | 		g.Header(v.Key, v.Val) | ||||||
|  | 	} | ||||||
|  | 	for _, v := range j.cookies { | ||||||
|  | 		g.SetCookie(v.name, v.value, v.maxAge, v.path, v.domain, v.secure, v.httpOnly) | ||||||
|  | 	} | ||||||
|  | 	g.String(j.statusCode, "%s", j.data) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j textHTTPResponse) WithHeader(k string, v string) HTTPResponse { | ||||||
|  | 	j.headers = append(j.headers, headerval{k, v}) | ||||||
|  | 	return j | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j textHTTPResponse) WithCookie(name string, value string, maxAge int, path string, domain string, secure bool, httpOnly bool) HTTPResponse { | ||||||
|  | 	j.cookies = append(j.cookies, cookieval{name, value, maxAge, path, domain, secure, httpOnly}) | ||||||
|  | 	return j | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j textHTTPResponse) IsSuccess() bool { | ||||||
|  | 	return j.statusCode >= 200 && j.statusCode <= 399 | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j textHTTPResponse) Statuscode() int { | ||||||
|  | 	return j.statusCode | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j textHTTPResponse) BodyString(*gin.Context) *string { | ||||||
|  | 	return langext.Ptr(j.data) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j textHTTPResponse) ContentType() string { | ||||||
|  | 	return "text/plain" | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (j textHTTPResponse) Headers() []string { | ||||||
|  | 	return langext.ArrMap(j.headers, func(v headerval) string { return v.Key + "=" + v.Val }) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func Text(sc int, data string) HTTPResponse { | ||||||
|  | 	return &textHTTPResponse{statusCode: sc, data: data} | ||||||
|  | } | ||||||
							
								
								
									
										273
									
								
								ginext/routes.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										273
									
								
								ginext/routes.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,273 @@ | |||||||
|  | package ginext | ||||||
|  |  | ||||||
|  | import ( | ||||||
|  | 	"git.blackforestbytes.com/BlackForestBytes/goext/langext" | ||||||
|  | 	"github.com/gin-gonic/gin" | ||||||
|  | 	"net/http" | ||||||
|  | 	"path" | ||||||
|  | 	"reflect" | ||||||
|  | 	"runtime" | ||||||
|  | 	"strings" | ||||||
|  | ) | ||||||
|  |  | ||||||
|  | var anyMethods = []string{ | ||||||
|  | 	http.MethodGet, http.MethodPost, http.MethodPut, http.MethodPatch, | ||||||
|  | 	http.MethodHead, http.MethodOptions, http.MethodDelete, http.MethodConnect, | ||||||
|  | 	http.MethodTrace, | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type GinRoutesWrapper struct { | ||||||
|  | 	wrapper        *GinWrapper | ||||||
|  | 	routes         gin.IRouter | ||||||
|  | 	absPath        string | ||||||
|  | 	defaultHandler []gin.HandlerFunc | ||||||
|  | } | ||||||
|  |  | ||||||
|  | type GinRouteBuilder struct { | ||||||
|  | 	routes *GinRoutesWrapper | ||||||
|  |  | ||||||
|  | 	method   string | ||||||
|  | 	relPath  string | ||||||
|  | 	absPath  string | ||||||
|  | 	handlers []gin.HandlerFunc | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (w *GinWrapper) Routes() *GinRoutesWrapper { | ||||||
|  | 	return &GinRoutesWrapper{ | ||||||
|  | 		wrapper:        w, | ||||||
|  | 		routes:         w.engine, | ||||||
|  | 		absPath:        "", | ||||||
|  | 		defaultHandler: make([]gin.HandlerFunc, 0), | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (w *GinRoutesWrapper) Group(relativePath string) *GinRoutesWrapper { | ||||||
|  | 	return &GinRoutesWrapper{ | ||||||
|  | 		wrapper:        w.wrapper, | ||||||
|  | 		routes:         w.routes.Group(relativePath), | ||||||
|  | 		defaultHandler: langext.ArrCopy(w.defaultHandler), | ||||||
|  | 		absPath:        joinPaths(w.absPath, relativePath), | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (w *GinRoutesWrapper) Use(middleware ...gin.HandlerFunc) *GinRoutesWrapper { | ||||||
|  | 	defHandler := langext.ArrCopy(w.defaultHandler) | ||||||
|  | 	defHandler = append(defHandler, middleware...) | ||||||
|  | 	return &GinRoutesWrapper{wrapper: w.wrapper, routes: w.routes, defaultHandler: defHandler, absPath: w.absPath} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (w *GinRoutesWrapper) WithJSONFilter(filter string) *GinRoutesWrapper { | ||||||
|  | 	return w.Use(func(g *gin.Context) { g.Set(jsonFilterKey, filter) }) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (w *GinRoutesWrapper) GET(relativePath string) *GinRouteBuilder { | ||||||
|  | 	return w._route(http.MethodGet, relativePath) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (w *GinRoutesWrapper) POST(relativePath string) *GinRouteBuilder { | ||||||
|  | 	return w._route(http.MethodPost, relativePath) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (w *GinRoutesWrapper) DELETE(relativePath string) *GinRouteBuilder { | ||||||
|  | 	return w._route(http.MethodDelete, relativePath) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (w *GinRoutesWrapper) PATCH(relativePath string) *GinRouteBuilder { | ||||||
|  | 	return w._route(http.MethodPatch, relativePath) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (w *GinRoutesWrapper) PUT(relativePath string) *GinRouteBuilder { | ||||||
|  | 	return w._route(http.MethodPut, relativePath) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (w *GinRoutesWrapper) OPTIONS(relativePath string) *GinRouteBuilder { | ||||||
|  | 	return w._route(http.MethodOptions, relativePath) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (w *GinRoutesWrapper) HEAD(relativePath string) *GinRouteBuilder { | ||||||
|  | 	return w._route(http.MethodHead, relativePath) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (w *GinRoutesWrapper) COUNT(relativePath string) *GinRouteBuilder { | ||||||
|  | 	return w._route("COUNT", relativePath) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (w *GinRoutesWrapper) Any(relativePath string) *GinRouteBuilder { | ||||||
|  | 	return w._route("*", relativePath) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (w *GinRoutesWrapper) _route(method string, relativePath string) *GinRouteBuilder { | ||||||
|  | 	return &GinRouteBuilder{ | ||||||
|  | 		routes:   w, | ||||||
|  | 		method:   method, | ||||||
|  | 		relPath:  relativePath, | ||||||
|  | 		absPath:  joinPaths(w.absPath, relativePath), | ||||||
|  | 		handlers: langext.ArrCopy(w.defaultHandler), | ||||||
|  | 	} | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (w *GinRouteBuilder) Use(middleware ...gin.HandlerFunc) *GinRouteBuilder { | ||||||
|  | 	w.handlers = append(w.handlers, middleware...) | ||||||
|  | 	return w | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (w *GinRouteBuilder) WithJSONFilter(filter string) *GinRouteBuilder { | ||||||
|  | 	return w.Use(func(g *gin.Context) { g.Set(jsonFilterKey, filter) }) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (w *GinRouteBuilder) Handle(handler WHandlerFunc) { | ||||||
|  |  | ||||||
|  | 	if w.routes.wrapper.bufferBody { | ||||||
|  | 		arr := make([]gin.HandlerFunc, 0, len(w.handlers)+1) | ||||||
|  | 		arr = append(arr, BodyBuffer) | ||||||
|  | 		arr = append(arr, w.handlers...) | ||||||
|  | 		w.handlers = arr | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	middlewareNames := langext.ArrMap(w.handlers, func(v gin.HandlerFunc) string { return nameOfFunction(v) }) | ||||||
|  | 	handlerName := nameOfFunction(handler) | ||||||
|  |  | ||||||
|  | 	w.handlers = append(w.handlers, Wrap(w.routes.wrapper, handler)) | ||||||
|  |  | ||||||
|  | 	methodName := w.method | ||||||
|  |  | ||||||
|  | 	if w.method == "*" { | ||||||
|  | 		methodName = "ANY" | ||||||
|  | 		for _, method := range anyMethods { | ||||||
|  | 			w.routes.routes.Handle(method, w.relPath, w.handlers...) | ||||||
|  | 		} | ||||||
|  | 	} else { | ||||||
|  | 		w.routes.routes.Handle(w.method, w.relPath, w.handlers...) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	w.routes.wrapper.routeSpecs = append(w.routes.wrapper.routeSpecs, ginRouteSpec{ | ||||||
|  | 		Method:      methodName, | ||||||
|  | 		URL:         w.absPath, | ||||||
|  | 		Middlewares: middlewareNames, | ||||||
|  | 		Handler:     handlerName, | ||||||
|  | 	}) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (w *GinRouteBuilder) HandleRawHTTPHandler(f http.Handler) { | ||||||
|  | 	if w.routes.wrapper.bufferBody { | ||||||
|  | 		arr := make([]gin.HandlerFunc, 0, len(w.handlers)+1) | ||||||
|  | 		arr = append(arr, BodyBuffer) | ||||||
|  | 		arr = append(arr, w.handlers...) | ||||||
|  | 		w.handlers = arr | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	middlewareNames := langext.ArrMap(w.handlers, func(v gin.HandlerFunc) string { return nameOfFunction(v) }) | ||||||
|  |  | ||||||
|  | 	w.handlers = append(w.handlers, WrapHTTPHandler(w.routes.wrapper, f)) | ||||||
|  |  | ||||||
|  | 	methodName := w.method | ||||||
|  |  | ||||||
|  | 	if w.method == "*" { | ||||||
|  | 		methodName = "ANY" | ||||||
|  | 		for _, method := range anyMethods { | ||||||
|  | 			w.routes.routes.Handle(method, w.relPath, w.handlers...) | ||||||
|  | 		} | ||||||
|  | 	} else { | ||||||
|  | 		w.routes.routes.Handle(w.method, w.relPath, w.handlers...) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	w.routes.wrapper.routeSpecs = append(w.routes.wrapper.routeSpecs, ginRouteSpec{ | ||||||
|  | 		Method:      methodName, | ||||||
|  | 		URL:         w.absPath, | ||||||
|  | 		Middlewares: middlewareNames, | ||||||
|  | 		Handler:     "[HTTPHandler]", | ||||||
|  | 	}) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (w *GinRouteBuilder) HandleRawHTTPHandlerFunc(f http.HandlerFunc) { | ||||||
|  | 	if w.routes.wrapper.bufferBody { | ||||||
|  | 		arr := make([]gin.HandlerFunc, 0, len(w.handlers)+1) | ||||||
|  | 		arr = append(arr, BodyBuffer) | ||||||
|  | 		arr = append(arr, w.handlers...) | ||||||
|  | 		w.handlers = arr | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	middlewareNames := langext.ArrMap(w.handlers, func(v gin.HandlerFunc) string { return nameOfFunction(v) }) | ||||||
|  |  | ||||||
|  | 	w.handlers = append(w.handlers, WrapHTTPHandlerFunc(w.routes.wrapper, f)) | ||||||
|  |  | ||||||
|  | 	methodName := w.method | ||||||
|  |  | ||||||
|  | 	if w.method == "*" { | ||||||
|  | 		methodName = "ANY" | ||||||
|  | 		for _, method := range anyMethods { | ||||||
|  | 			w.routes.routes.Handle(method, w.relPath, w.handlers...) | ||||||
|  | 		} | ||||||
|  | 	} else { | ||||||
|  | 		w.routes.routes.Handle(w.method, w.relPath, w.handlers...) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	w.routes.wrapper.routeSpecs = append(w.routes.wrapper.routeSpecs, ginRouteSpec{ | ||||||
|  | 		Method:      methodName, | ||||||
|  | 		URL:         w.absPath, | ||||||
|  | 		Middlewares: middlewareNames, | ||||||
|  | 		Handler:     "[HTTPHandlerFunc]", | ||||||
|  | 	}) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func (w *GinWrapper) NoRoute(handler WHandlerFunc) { | ||||||
|  |  | ||||||
|  | 	handlers := make([]gin.HandlerFunc, 0) | ||||||
|  |  | ||||||
|  | 	if w.bufferBody { | ||||||
|  | 		handlers = append(handlers, BodyBuffer) | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	middlewareNames := langext.ArrMap(handlers, func(v gin.HandlerFunc) string { return nameOfFunction(v) }) | ||||||
|  | 	handlerName := nameOfFunction(handler) | ||||||
|  |  | ||||||
|  | 	handlers = append(handlers, Wrap(w, handler)) | ||||||
|  |  | ||||||
|  | 	w.engine.NoRoute(handlers...) | ||||||
|  |  | ||||||
|  | 	w.routeSpecs = append(w.routeSpecs, ginRouteSpec{ | ||||||
|  | 		Method:      "ANY", | ||||||
|  | 		URL:         "[NO_ROUTE]", | ||||||
|  | 		Middlewares: middlewareNames, | ||||||
|  | 		Handler:     handlerName, | ||||||
|  | 	}) | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func nameOfFunction(f any) string { | ||||||
|  |  | ||||||
|  | 	fname := runtime.FuncForPC(reflect.ValueOf(f).Pointer()).Name() | ||||||
|  |  | ||||||
|  | 	split := strings.Split(fname, "/") | ||||||
|  | 	if len(split) == 0 { | ||||||
|  | 		return "" | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	fname = split[len(split)-1] | ||||||
|  |  | ||||||
|  | 	// https://stackoverflow.com/a/32925345/1761622 | ||||||
|  | 	if strings.HasSuffix(fname, "-fm") { | ||||||
|  | 		fname = fname[:len(fname)-len("-fm")] | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	return fname | ||||||
|  | } | ||||||
|  |  | ||||||
|  | // joinPaths is copied verbatim from gin@v1.9.1/gin.go | ||||||
|  | func joinPaths(absolutePath, relativePath string) string { | ||||||
|  | 	if relativePath == "" { | ||||||
|  | 		return absolutePath | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | 	finalPath := path.Join(absolutePath, relativePath) | ||||||
|  | 	if lastChar(relativePath) == '/' && lastChar(finalPath) != '/' { | ||||||
|  | 		return finalPath + "/" | ||||||
|  | 	} | ||||||
|  | 	return finalPath | ||||||
|  | } | ||||||
|  |  | ||||||
|  | func lastChar(str string) uint8 { | ||||||
|  | 	if str == "" { | ||||||
|  | 		panic("The length of the string can't be 0") | ||||||
|  | 	} | ||||||
|  | 	return str[len(str)-1] | ||||||
|  | } | ||||||
Some files were not shown because too many files have changed in this diff Show More
		Reference in New Issue
	
	Block a user