├── .github └── workflows │ └── test.yml ├── .gitignore ├── .tool-versions ├── CHANGELOG.md ├── LICENCE ├── README.md ├── gleam.toml ├── manifest.toml ├── src ├── stacky.gleam ├── stacky │ └── internal │ │ └── examples │ │ ├── example_1.gleam │ │ ├── example_2.gleam │ │ ├── example_3.gleam │ │ ├── example_3 │ │ └── module_with_stacky_call.gleam │ │ ├── example_4.gleam │ │ └── example_readme.gleam └── stacky_ffi.erl └── test └── stacky_test.gleam /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: test 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | pull_request: 8 | 9 | jobs: 10 | test: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: actions/checkout@v4 14 | - uses: erlef/setup-beam@v1 15 | with: 16 | otp-version: "27.0" 17 | gleam-version: "1.2.1" 18 | rebar3-version: "3" 19 | - run: gleam deps download 20 | - run: gleam test --target erlang 21 | - run: gleam format --check src test 22 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.beam 2 | *.ez 3 | /build 4 | erl_crash.dump 5 | -------------------------------------------------------------------------------- /.tool-versions: -------------------------------------------------------------------------------- 1 | erlang 27.0 2 | gleam 1.2.1 3 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | ## 2.0.0 - 2024-06-06 4 | 5 | - Added `call_and_catch_panics` to catch panics and return a `Result`. 6 | Please run `gleam run -m stacky/internal/examples/example_4` 7 | to see what it does. 8 | - Returning reason, and by that the included panic message from gleams panics. 9 | 10 | ## 1.4.0 - 2024-06-06 11 | 12 | - Traverse the stack trace only once to enumerate it. 13 | - Updated for Erlang/OTP 27. 14 | - Updated for Gleam 1.2.0. 15 | 16 | ## 1.3.0 - 2024-05-17 17 | 18 | - Improved formatting. 19 | - Make gleam source modules clickable. 20 | 21 | ## 1.2.0 - 2024-05-17 22 | 23 | - Added index lookup functions from last to first (list index) 24 | and/or first to last (stack frame index). 25 | 26 | ## 1.1.0 - 2024-05-16 27 | 28 | - Addded inverse trace index. 29 | - Added better stdout printing. 30 | 31 | ## 1.0.3 - 2024-05-15 32 | 33 | - Fixes "not a file". 34 | 35 | ## 1.0.2 - 2024-05-15 36 | 37 | - Pinned Erlang and Gleam versions and fix CI. 38 | - Added changelog. 39 | 40 | ## 1.0.1 - 2024-05-15 41 | 42 | - Improved readme. 43 | 44 | ## 1.0.0 - 2024-05-15 45 | 46 | - Released initial version. 47 | -------------------------------------------------------------------------------- /LICENCE: -------------------------------------------------------------------------------- 1 | Mozilla Public License Version 2.0 2 | ================================== 3 | 4 | 1. Definitions 5 | -------------- 6 | 7 | 1.1. "Contributor" 8 | means each individual or legal entity that creates, contributes to 9 | the creation of, or owns Covered Software. 10 | 11 | 1.2. "Contributor Version" 12 | means the combination of the Contributions of others (if any) used 13 | by a Contributor and that particular Contributor's Contribution. 14 | 15 | 1.3. "Contribution" 16 | means Covered Software of a particular Contributor. 17 | 18 | 1.4. "Covered Software" 19 | means Source Code Form to which the initial Contributor has attached 20 | the notice in Exhibit A, the Executable Form of such Source Code 21 | Form, and Modifications of such Source Code Form, in each case 22 | including portions thereof. 23 | 24 | 1.5. "Incompatible With Secondary Licenses" 25 | means 26 | 27 | (a) that the initial Contributor has attached the notice described 28 | in Exhibit B to the Covered Software; or 29 | 30 | (b) that the Covered Software was made available under the terms of 31 | version 1.1 or earlier of the License, but not also under the 32 | terms of a Secondary License. 33 | 34 | 1.6. "Executable Form" 35 | means any form of the work other than Source Code Form. 36 | 37 | 1.7. "Larger Work" 38 | means a work that combines Covered Software with other material, in 39 | a separate file or files, that is not Covered Software. 40 | 41 | 1.8. "License" 42 | means this document. 43 | 44 | 1.9. "Licensable" 45 | means having the right to grant, to the maximum extent possible, 46 | whether at the time of the initial grant or subsequently, any and 47 | all of the rights conveyed by this License. 48 | 49 | 1.10. "Modifications" 50 | means any of the following: 51 | 52 | (a) any file in Source Code Form that results from an addition to, 53 | deletion from, or modification of the contents of Covered 54 | Software; or 55 | 56 | (b) any new file in Source Code Form that contains any Covered 57 | Software. 58 | 59 | 1.11. "Patent Claims" of a Contributor 60 | means any patent claim(s), including without limitation, method, 61 | process, and apparatus claims, in any patent Licensable by such 62 | Contributor that would be infringed, but for the grant of the 63 | License, by the making, using, selling, offering for sale, having 64 | made, import, or transfer of either its Contributions or its 65 | Contributor Version. 66 | 67 | 1.12. "Secondary License" 68 | means either the GNU General Public License, Version 2.0, the GNU 69 | Lesser General Public License, Version 2.1, the GNU Affero General 70 | Public License, Version 3.0, or any later versions of those 71 | licenses. 72 | 73 | 1.13. "Source Code Form" 74 | means the form of the work preferred for making modifications. 75 | 76 | 1.14. "You" (or "Your") 77 | means an individual or a legal entity exercising rights under this 78 | License. For legal entities, "You" includes any entity that 79 | controls, is controlled by, or is under common control with You. For 80 | purposes of this definition, "control" means (a) the power, direct 81 | or indirect, to cause the direction or management of such entity, 82 | whether by contract or otherwise, or (b) ownership of more than 83 | fifty percent (50%) of the outstanding shares or beneficial 84 | ownership of such entity. 85 | 86 | 2. License Grants and Conditions 87 | -------------------------------- 88 | 89 | 2.1. Grants 90 | 91 | Each Contributor hereby grants You a world-wide, royalty-free, 92 | non-exclusive license: 93 | 94 | (a) under intellectual property rights (other than patent or trademark) 95 | Licensable by such Contributor to use, reproduce, make available, 96 | modify, display, perform, distribute, and otherwise exploit its 97 | Contributions, either on an unmodified basis, with Modifications, or 98 | as part of a Larger Work; and 99 | 100 | (b) under Patent Claims of such Contributor to make, use, sell, offer 101 | for sale, have made, import, and otherwise transfer either its 102 | Contributions or its Contributor Version. 103 | 104 | 2.2. Effective Date 105 | 106 | The licenses granted in Section 2.1 with respect to any Contribution 107 | become effective for each Contribution on the date the Contributor first 108 | distributes such Contribution. 109 | 110 | 2.3. Limitations on Grant Scope 111 | 112 | The licenses granted in this Section 2 are the only rights granted under 113 | this License. No additional rights or licenses will be implied from the 114 | distribution or licensing of Covered Software under this License. 115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a 116 | Contributor: 117 | 118 | (a) for any code that a Contributor has removed from Covered Software; 119 | or 120 | 121 | (b) for infringements caused by: (i) Your and any other third party's 122 | modifications of Covered Software, or (ii) the combination of its 123 | Contributions with other software (except as part of its Contributor 124 | Version); or 125 | 126 | (c) under Patent Claims infringed by Covered Software in the absence of 127 | its Contributions. 128 | 129 | This License does not grant any rights in the trademarks, service marks, 130 | or logos of any Contributor (except as may be necessary to comply with 131 | the notice requirements in Section 3.4). 132 | 133 | 2.4. Subsequent Licenses 134 | 135 | No Contributor makes additional grants as a result of Your choice to 136 | distribute the Covered Software under a subsequent version of this 137 | License (see Section 10.2) or under the terms of a Secondary License (if 138 | permitted under the terms of Section 3.3). 139 | 140 | 2.5. Representation 141 | 142 | Each Contributor represents that the Contributor believes its 143 | Contributions are its original creation(s) or it has sufficient rights 144 | to grant the rights to its Contributions conveyed by this License. 145 | 146 | 2.6. Fair Use 147 | 148 | This License is not intended to limit any rights You have under 149 | applicable copyright doctrines of fair use, fair dealing, or other 150 | equivalents. 151 | 152 | 2.7. Conditions 153 | 154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted 155 | in Section 2.1. 156 | 157 | 3. Responsibilities 158 | ------------------- 159 | 160 | 3.1. Distribution of Source Form 161 | 162 | All distribution of Covered Software in Source Code Form, including any 163 | Modifications that You create or to which You contribute, must be under 164 | the terms of this License. You must inform recipients that the Source 165 | Code Form of the Covered Software is governed by the terms of this 166 | License, and how they can obtain a copy of this License. You may not 167 | attempt to alter or restrict the recipients' rights in the Source Code 168 | Form. 169 | 170 | 3.2. Distribution of Executable Form 171 | 172 | If You distribute Covered Software in Executable Form then: 173 | 174 | (a) such Covered Software must also be made available in Source Code 175 | Form, as described in Section 3.1, and You must inform recipients of 176 | the Executable Form how they can obtain a copy of such Source Code 177 | Form by reasonable means in a timely manner, at a charge no more 178 | than the cost of distribution to the recipient; and 179 | 180 | (b) You may distribute such Executable Form under the terms of this 181 | License, or sublicense it under different terms, provided that the 182 | license for the Executable Form does not attempt to limit or alter 183 | the recipients' rights in the Source Code Form under this License. 184 | 185 | 3.3. Distribution of a Larger Work 186 | 187 | You may create and distribute a Larger Work under terms of Your choice, 188 | provided that You also comply with the requirements of this License for 189 | the Covered Software. If the Larger Work is a combination of Covered 190 | Software with a work governed by one or more Secondary Licenses, and the 191 | Covered Software is not Incompatible With Secondary Licenses, this 192 | License permits You to additionally distribute such Covered Software 193 | under the terms of such Secondary License(s), so that the recipient of 194 | the Larger Work may, at their option, further distribute the Covered 195 | Software under the terms of either this License or such Secondary 196 | License(s). 197 | 198 | 3.4. Notices 199 | 200 | You may not remove or alter the substance of any license notices 201 | (including copyright notices, patent notices, disclaimers of warranty, 202 | or limitations of liability) contained within the Source Code Form of 203 | the Covered Software, except that You may alter any license notices to 204 | the extent required to remedy known factual inaccuracies. 205 | 206 | 3.5. Application of Additional Terms 207 | 208 | You may choose to offer, and to charge a fee for, warranty, support, 209 | indemnity or liability obligations to one or more recipients of Covered 210 | Software. However, You may do so only on Your own behalf, and not on 211 | behalf of any Contributor. You must make it absolutely clear that any 212 | such warranty, support, indemnity, or liability obligation is offered by 213 | You alone, and You hereby agree to indemnify every Contributor for any 214 | liability incurred by such Contributor as a result of warranty, support, 215 | indemnity or liability terms You offer. You may include additional 216 | disclaimers of warranty and limitations of liability specific to any 217 | jurisdiction. 218 | 219 | 4. Inability to Comply Due to Statute or Regulation 220 | --------------------------------------------------- 221 | 222 | If it is impossible for You to comply with any of the terms of this 223 | License with respect to some or all of the Covered Software due to 224 | statute, judicial order, or regulation then You must: (a) comply with 225 | the terms of this License to the maximum extent possible; and (b) 226 | describe the limitations and the code they affect. Such description must 227 | be placed in a text file included with all distributions of the Covered 228 | Software under this License. Except to the extent prohibited by statute 229 | or regulation, such description must be sufficiently detailed for a 230 | recipient of ordinary skill to be able to understand it. 231 | 232 | 5. Termination 233 | -------------- 234 | 235 | 5.1. The rights granted under this License will terminate automatically 236 | if You fail to comply with any of its terms. However, if You become 237 | compliant, then the rights granted under this License from a particular 238 | Contributor are reinstated (a) provisionally, unless and until such 239 | Contributor explicitly and finally terminates Your grants, and (b) on an 240 | ongoing basis, if such Contributor fails to notify You of the 241 | non-compliance by some reasonable means prior to 60 days after You have 242 | come back into compliance. Moreover, Your grants from a particular 243 | Contributor are reinstated on an ongoing basis if such Contributor 244 | notifies You of the non-compliance by some reasonable means, this is the 245 | first time You have received notice of non-compliance with this License 246 | from such Contributor, and You become compliant prior to 30 days after 247 | Your receipt of the notice. 248 | 249 | 5.2. If You initiate litigation against any entity by asserting a patent 250 | infringement claim (excluding declaratory judgment actions, 251 | counter-claims, and cross-claims) alleging that a Contributor Version 252 | directly or indirectly infringes any patent, then the rights granted to 253 | You by any and all Contributors for the Covered Software under Section 254 | 2.1 of this License shall terminate. 255 | 256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all 257 | end user license agreements (excluding distributors and resellers) which 258 | have been validly granted by You or Your distributors under this License 259 | prior to termination shall survive termination. 260 | 261 | ************************************************************************ 262 | * * 263 | * 6. Disclaimer of Warranty * 264 | * ------------------------- * 265 | * * 266 | * Covered Software is provided under this License on an "as is" * 267 | * basis, without warranty of any kind, either expressed, implied, or * 268 | * statutory, including, without limitation, warranties that the * 269 | * Covered Software is free of defects, merchantable, fit for a * 270 | * particular purpose or non-infringing. The entire risk as to the * 271 | * quality and performance of the Covered Software is with You. * 272 | * Should any Covered Software prove defective in any respect, You * 273 | * (not any Contributor) assume the cost of any necessary servicing, * 274 | * repair, or correction. This disclaimer of warranty constitutes an * 275 | * essential part of this License. No use of any Covered Software is * 276 | * authorized under this License except under this disclaimer. * 277 | * * 278 | ************************************************************************ 279 | 280 | ************************************************************************ 281 | * * 282 | * 7. Limitation of Liability * 283 | * -------------------------- * 284 | * * 285 | * Under no circumstances and under no legal theory, whether tort * 286 | * (including negligence), contract, or otherwise, shall any * 287 | * Contributor, or anyone who distributes Covered Software as * 288 | * permitted above, be liable to You for any direct, indirect, * 289 | * special, incidental, or consequential damages of any character * 290 | * including, without limitation, damages for lost profits, loss of * 291 | * goodwill, work stoppage, computer failure or malfunction, or any * 292 | * and all other commercial damages or losses, even if such party * 293 | * shall have been informed of the possibility of such damages. This * 294 | * limitation of liability shall not apply to liability for death or * 295 | * personal injury resulting from such party's negligence to the * 296 | * extent applicable law prohibits such limitation. Some * 297 | * jurisdictions do not allow the exclusion or limitation of * 298 | * incidental or consequential damages, so this exclusion and * 299 | * limitation may not apply to You. * 300 | * * 301 | ************************************************************************ 302 | 303 | 8. Litigation 304 | ------------- 305 | 306 | Any litigation relating to this License may be brought only in the 307 | courts of a jurisdiction where the defendant maintains its principal 308 | place of business and such litigation shall be governed by laws of that 309 | jurisdiction, without reference to its conflict-of-law provisions. 310 | Nothing in this Section shall prevent a party's ability to bring 311 | cross-claims or counter-claims. 312 | 313 | 9. Miscellaneous 314 | ---------------- 315 | 316 | This License represents the complete agreement concerning the subject 317 | matter hereof. If any provision of this License is held to be 318 | unenforceable, such provision shall be reformed only to the extent 319 | necessary to make it enforceable. Any law or regulation which provides 320 | that the language of a contract shall be construed against the drafter 321 | shall not be used to construe this License against a Contributor. 322 | 323 | 10. Versions of the License 324 | --------------------------- 325 | 326 | 10.1. New Versions 327 | 328 | Mozilla Foundation is the license steward. Except as provided in Section 329 | 10.3, no one other than the license steward has the right to modify or 330 | publish new versions of this License. Each version will be given a 331 | distinguishing version number. 332 | 333 | 10.2. Effect of New Versions 334 | 335 | You may distribute the Covered Software under the terms of the version 336 | of the License under which You originally received the Covered Software, 337 | or under the terms of any subsequent version published by the license 338 | steward. 339 | 340 | 10.3. Modified Versions 341 | 342 | If you create software not governed by this License, and you want to 343 | create a new license for such software, you may create and use a 344 | modified version of this License if you rename the license and remove 345 | any references to the name of the license steward (except to note that 346 | such modified license differs from this License). 347 | 348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary 349 | Licenses 350 | 351 | If You choose to distribute Source Code Form that is Incompatible With 352 | Secondary Licenses under the terms of this version of the License, the 353 | notice described in Exhibit B of this License must be attached. 354 | 355 | Exhibit A - Source Code Form License Notice 356 | ------------------------------------------- 357 | 358 | This Source Code Form is subject to the terms of the Mozilla Public 359 | License, v. 2.0. If a copy of the MPL was not distributed with this 360 | file, You can obtain one at http://mozilla.org/MPL/2.0/. 361 | 362 | If it is not possible or desirable to put the notice in a particular 363 | file, then You may include the notice in a location (such as a LICENSE 364 | file in a relevant directory) where a recipient would be likely to look 365 | for such a notice. 366 | 367 | You may add additional accurate notices of copyright ownership. 368 | 369 | Exhibit B - "Incompatible With Secondary Licenses" Notice 370 | --------------------------------------------------------- 371 | 372 | This Source Code Form is "Incompatible With Secondary Licenses", as 373 | defined by the Mozilla Public License, v. 2.0. 374 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Stacky ☆ BEAM stack trace in Gleam 2 | 3 | ![Erlang-compatible](https://img.shields.io/badge/target-erlang-b83998) 4 | Documentation 5 | Available on Hex 6 | ![CI](https://github.com/inoas/stacky/actions/workflows/test.yml/badge.svg?branch=main) 7 | Discord chat 8 | 9 | **A stack trace of stack frames with module name, function name, arity, file name and line number!** 10 | 11 | ## Installation 12 | 13 | ```shell 14 | gleam add stacky 15 | ``` 16 | 17 | ## Usage 18 | 19 | ```gleam 20 | let stacktrace = stacky.trace() 21 | 22 | io.print("\n") 23 | 24 | io.println("Trace to string:") 25 | 26 | stacktrace |> stacky.print_trace 27 | 28 | io.print("\n") 29 | 30 | io.println("Frame with context:") 31 | 32 | stackframe |> stacky.print_frame_with(context: #("my_context")) 33 | ``` 34 | 35 | `stdout` example: 36 | 37 | ```plaintext 38 | Trace to string: 39 | # 06 main() of src/stacky/internal/examples/example_readme.gleam 40 | in /SOME_PATH/stacky/build/dev/erlang/stacky/_gleam_artefacts/stacky@internal@examples@example_readme.erl:8 41 | # 05 stacky@@main:run/1 42 | in /SOME_PATH/stacky/build/dev/erlang/stacky/_gleam_artefacts/stacky@@main.erl:11 43 | # 04 erl_eval:do_apply/7 44 | in erl_eval.erl:746 45 | # 03 init:start_it/1 46 | # 02 init:start_em/1 47 | # 01 init:do_boot/3 48 | 49 | Frame with context: 50 | # 06 main() of src/stacky/internal/examples/example_readme.gleam 51 | in /Users/leo/local-dev/gleam/stacky/build/dev/erlang/stacky/_gleam_artefacts/stacky@internal@examples@example_readme.erl:8 52 | context: #("my_context") 53 | ``` 54 | 55 | ## Demos 56 | 57 | ```shell 58 | gleam run --module stacky/internal/examples/example_1 59 | gleam run --module stacky/internal/examples/example_2 60 | gleam run --module stacky/internal/examples/example_3 61 | ``` 62 | 63 | Further documentation can be found at . 64 | -------------------------------------------------------------------------------- /gleam.toml: -------------------------------------------------------------------------------- 1 | name = "stacky" 2 | version = "2.0.0" 3 | description = "BEAM stack trace in Gleam: a stack trace of stack frames with module name, function name, arity, file name and line number." 4 | licences = ["MPL-2.0"] 5 | repository = { type = "github", user = "inoas", repo = "stacky" } 6 | 7 | gleam = ">= 1.0.0 and < 2.0.0" 8 | target = "erlang" 9 | 10 | [dependencies] 11 | gleam_stdlib = ">= 0.38.0 and < 2.0.0" 12 | pprint = ">= 1.0.3 and < 2.0.0" 13 | gleam_erlang = ">= 0.25.0 and < 2.0.0" 14 | 15 | [dev-dependencies] 16 | gleeunit = ">= 1.1.2 and < 2.0.0" 17 | -------------------------------------------------------------------------------- /manifest.toml: -------------------------------------------------------------------------------- 1 | # This file was generated by Gleam 2 | # You typically do not need to edit this file 3 | 4 | packages = [ 5 | { name = "glam", version = "2.0.1", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "glam", source = "hex", outer_checksum = "66EC3BCD632E51EED029678F8DF419659C1E57B1A93D874C5131FE220DFAD2B2" }, 6 | { name = "gleam_erlang", version = "0.25.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_erlang", source = "hex", outer_checksum = "054D571A7092D2A9727B3E5D183B7507DAB0DA41556EC9133606F09C15497373" }, 7 | { name = "gleam_stdlib", version = "0.38.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "663CF11861179AF415A625307447775C09404E752FF99A24E2057C835319F1BE" }, 8 | { name = "gleeunit", version = "1.1.2", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleeunit", source = "hex", outer_checksum = "72CDC3D3F719478F26C4E2C5FED3E657AC81EC14A47D2D2DEBB8693CA3220C3B" }, 9 | { name = "pprint", version = "1.0.3", build_tools = ["gleam"], requirements = ["glam", "gleam_stdlib"], otp_app = "pprint", source = "hex", outer_checksum = "76BBB92E23D12D954BD452686543F29EDE8EBEBB7FC0ACCBCA66EEF276EC3A06" }, 10 | ] 11 | 12 | [requirements] 13 | gleam_erlang = { version = ">= 0.25.0 and < 2.0.0" } 14 | gleam_stdlib = { version = ">= 0.38.0 and < 2.0.0" } 15 | gleeunit = { version = ">= 1.1.2 and < 2.0.0" } 16 | pprint = { version = ">= 1.0.3 and < 2.0.0" } 17 | -------------------------------------------------------------------------------- /src/stacky.gleam: -------------------------------------------------------------------------------- 1 | import gleam/erlang/process 2 | import gleam/int 3 | import gleam/io 4 | import gleam/list 5 | import gleam/regex 6 | import gleam/string 7 | import pprint 8 | 9 | /// Gets the stack trace of the current process. 10 | /// 11 | pub fn trace() -> StackTrace { 12 | let #(reason, erlang_stack_trace) = stacky_erlang_stack_trace() 13 | erlang_stack_trace |> convert_erlang_trace(reason |> pprint.format) 14 | } 15 | 16 | /// Calls a function and try catches any panic that occurs while executing. 17 | /// If no panic occured the result is returned as an Ok value. 18 | /// If any uncaught panic occured an Error with the stack trace is returned instead. 19 | /// 20 | pub fn call_and_catch_panics(f: fn() -> a) -> Result(a, StackTrace) { 21 | case stacky_erlang_call_and_catch_panics(f) { 22 | Ok(a) -> a |> Ok 23 | Error(#(reason, erlang_stack_trace)) -> { 24 | // Swallow call_and_catch_panics() call: 25 | let assert [_hd, ..erlang_stack_trace] = erlang_stack_trace 26 | 27 | erlang_stack_trace 28 | |> convert_erlang_trace(reason |> pprint.format) 29 | |> Error 30 | } 31 | } 32 | } 33 | 34 | fn convert_erlang_trace( 35 | erlang_stack_trace: List(#(Int, #(String, String, Int, String, Int))), 36 | reason: String, 37 | ) -> StackTrace { 38 | erlang_stack_trace 39 | |> list.map(fn(frame: FFIStackFrameTuple) { 40 | let #( 41 | stack_index, 42 | #( 43 | erlang_module_name, 44 | function_name, 45 | function_arity, 46 | erlang_file_name, 47 | erlang_line_number, 48 | ), 49 | ) = frame 50 | StackFrame( 51 | index: StackIndex(stack_index), 52 | erlang_module_name: ErlangModuleName(erlang_module_name), 53 | function_name: FunctionName(function_name), 54 | function_arity: FunctionArity(function_arity), 55 | erlang_file_name: ErlangFileName(erlang_file_name), 56 | erlang_line_number: ErlangLineNumber(erlang_line_number), 57 | ) 58 | }) 59 | |> StackTrace(reason: reason) 60 | } 61 | 62 | /// Gets the stack frame at the given 0-based list index 63 | /// where `0` is the last stack frame and `1` is the 64 | /// second-to-last stack frame and `size(stack_trace) - 1` 65 | /// is the first stack frame. 66 | /// 67 | /// The StackFrame itself has an inverse index field 68 | /// that represents the index of the frame within the stack. 69 | /// see `frame_by_stack_index`. 70 | /// 71 | pub fn frame(stack_trace: StackTrace, index: Int) -> StackFrame { 72 | let StackTrace(_reason, stack_trace) = stack_trace 73 | case 74 | stack_trace 75 | |> list_at(index) 76 | { 77 | Ok(stackframe) -> stackframe 78 | Error(_) -> { 79 | let panic_msg = 80 | "No stack frame at list index " <> int.to_string(index) <> "." 81 | panic as panic_msg 82 | } 83 | } 84 | } 85 | 86 | /// Gets the stack frame at the given 1-based stack index, 87 | /// where `1` is the first stack frame, `2` is the second stack frame, 88 | /// and size(stack_trace) is the last stack frame. 89 | /// 90 | pub fn frame_by_stack_index(stack_trace: StackTrace, index: Int) -> StackFrame { 91 | let StackTrace(_reason, stack_trace) = stack_trace 92 | case 93 | stack_trace 94 | |> list.find(fn(item) { item.index == StackIndex(index) }) 95 | { 96 | Ok(stackframe) -> stackframe 97 | Error(_) -> { 98 | let panic_msg = 99 | "No stack frame with stack index " <> int.to_string(index) <> "." 100 | 101 | panic as panic_msg 102 | } 103 | } 104 | } 105 | 106 | /// Calculates the stack trace size. 107 | /// 108 | pub fn size(stack_trace: StackTrace) -> Int { 109 | let StackTrace(_reason, stack_trace) = stack_trace 110 | stack_trace 111 | |> list.length 112 | } 113 | 114 | /// Converts a stack frame to a string. 115 | /// 116 | pub fn frame_to_string(stack_frame: StackFrame) -> String { 117 | let stack_index = 118 | stack_frame 119 | |> stack_index() 120 | |> int.to_string 121 | let erlang_module_name = 122 | stack_frame 123 | |> erlang_module_name() 124 | let qualified_module_name = 125 | stack_frame 126 | |> qualified_module_name() 127 | let function_name = 128 | stack_frame 129 | |> function_name() 130 | let function_arity = 131 | stack_frame 132 | |> function_arity() 133 | |> int.to_string 134 | let erlang_file_name = 135 | stack_frame 136 | |> erlang_file_name() 137 | let erlang_line_number = 138 | stack_frame 139 | |> erlang_line_number() 140 | |> int.to_string 141 | 142 | let line = 143 | "#" 144 | <> " " 145 | <> stack_index 146 | |> string.pad_left(to: 2, with: "0") 147 | <> "\t" 148 | 149 | let line = case qualified_module_name != erlang_module_name { 150 | True -> { 151 | let gleam_module_file = 152 | qualified_module_name 153 | |> gleam_module_file() 154 | 155 | line <> function_name <> "() of " <> gleam_module_file 156 | } 157 | False -> 158 | line 159 | <> qualified_module_name 160 | <> ":" 161 | <> function_name 162 | <> "/" 163 | <> function_arity 164 | } 165 | 166 | line 167 | <> case erlang_file_name { 168 | "" -> "" 169 | _ -> "\n \tin " <> erlang_file_name <> ":" <> erlang_line_number 170 | } 171 | } 172 | 173 | fn gleam_module_file(qualified_module_name: String) -> String { 174 | "src/" <> qualified_module_name <> ".gleam" 175 | } 176 | 177 | /// Converts a stack trace to a string. 178 | /// 179 | pub fn trace_to_string(stack_frame: StackTrace) -> String { 180 | let StackTrace(reason, stack_trace) = stack_frame 181 | reason 182 | <> "\n" 183 | <> stack_trace 184 | |> list.map(fn(stack_frame) { 185 | stack_frame 186 | |> frame_to_string() 187 | }) 188 | |> string.join(with: "\n") 189 | } 190 | 191 | /// Print a stack frame. 192 | /// 193 | pub fn print_frame(stack_frame: StackFrame) { 194 | process.sleep(100) 195 | 196 | stack_frame 197 | |> frame_to_string() 198 | |> io.println 199 | 200 | process.sleep(100) 201 | } 202 | 203 | /// Print a stack frame with context. 204 | /// 205 | pub fn print_frame_with(stack_frame: StackFrame, context c: c) { 206 | process.sleep(100) 207 | 208 | stack_frame 209 | |> frame_to_string() 210 | |> io.print 211 | 212 | io.print("\n \tcontext: ") 213 | pprint.debug(c) 214 | 215 | process.sleep(100) 216 | } 217 | 218 | /// Print a stack trace. 219 | /// 220 | pub fn print_trace(stack_trace: StackTrace) { 221 | process.sleep(100) 222 | 223 | stack_trace 224 | |> trace_to_string() 225 | |> io.println 226 | 227 | process.sleep(100) 228 | } 229 | 230 | /// Print a stack trace with context. 231 | /// 232 | pub fn print_trace_with(stack_trace: StackTrace, context c: c) { 233 | process.sleep(100) 234 | 235 | stack_trace 236 | |> trace_to_string() 237 | |> io.print 238 | 239 | io.print("\nwith context: ") 240 | pprint.debug(c) 241 | 242 | process.sleep(100) 243 | } 244 | 245 | /// Gets the erlang module name of the stack frame. 246 | /// 247 | pub fn erlang_module_name(stack_frame: StackFrame) -> String { 248 | let ErlangModuleName(erlang_module_name) = stack_frame.erlang_module_name 249 | erlang_module_name 250 | } 251 | 252 | /// Gets the qualified module name from the erlang stack frame. 253 | /// 254 | /// In case the module name contains `@` (but no `@@`), 255 | /// those will be replaced with `/` to form a qualified module name. 256 | /// 257 | pub fn qualified_module_name(stack_frame: StackFrame) -> String { 258 | let erlang_module_name = 259 | stack_frame 260 | |> erlang_module_name() 261 | 262 | let assert Ok(double_at_re) = regex.from_string("@@") 263 | let assert Ok(single_at_re) = regex.from_string("@") 264 | let has_double_ats = 265 | erlang_module_name 266 | |> regex.scan(with: double_at_re) 267 | |> list.is_empty 268 | == False 269 | let has_ats = 270 | erlang_module_name 271 | |> regex.scan(with: single_at_re) 272 | |> list.is_empty 273 | == False 274 | 275 | case has_double_ats, has_ats { 276 | False, True -> 277 | erlang_module_name 278 | |> string.replace(each: "@", with: "/") 279 | _, _ -> erlang_module_name 280 | } 281 | } 282 | 283 | /// Gets the stack index within its parent stack frame. 284 | /// 285 | pub fn stack_index(stack_frame: StackFrame) -> Int { 286 | let StackIndex(stack_index) = stack_frame.index 287 | stack_index 288 | } 289 | 290 | /// Gets the function name of the stack frame. 291 | /// 292 | pub fn function_name(stack_frame: StackFrame) -> String { 293 | let FunctionName(function_name) = stack_frame.function_name 294 | function_name 295 | } 296 | 297 | /// Gets the function arity of the stack frame. 298 | /// 299 | pub fn function_arity(stack_frame: StackFrame) -> Int { 300 | let FunctionArity(function_arity) = stack_frame.function_arity 301 | function_arity 302 | } 303 | 304 | /// Gets the erlang file name of the stack frame. 305 | /// 306 | pub fn erlang_file_name(stack_frame: StackFrame) -> String { 307 | let ErlangFileName(erlang_file_name) = stack_frame.erlang_file_name 308 | erlang_file_name 309 | } 310 | 311 | /// Gets the ang erlline number of the stack frame. 312 | /// 313 | pub fn erlang_line_number(stack_frame: StackFrame) -> Int { 314 | let ErlangLineNumber(erlang_line_number) = stack_frame.erlang_line_number 315 | erlang_line_number 316 | } 317 | 318 | pub type StackTrace { 319 | StackTrace(reason: String, frames: List(StackFrame)) 320 | } 321 | 322 | pub type StackFrame { 323 | StackFrame( 324 | index: StackIndex, 325 | erlang_module_name: ErlangModuleName, 326 | function_name: FunctionName, 327 | function_arity: FunctionArity, 328 | erlang_file_name: ErlangFileName, 329 | erlang_line_number: ErlangLineNumber, 330 | ) 331 | } 332 | 333 | pub type StackIndex { 334 | StackIndex(Int) 335 | } 336 | 337 | pub type ErlangModuleName { 338 | ErlangModuleName(String) 339 | } 340 | 341 | pub type FunctionName { 342 | FunctionName(String) 343 | } 344 | 345 | pub type FunctionArity { 346 | FunctionArity(Int) 347 | } 348 | 349 | pub type ErlangFileName { 350 | ErlangFileName(String) 351 | } 352 | 353 | pub type ErlangLineNumber { 354 | ErlangLineNumber(Int) 355 | } 356 | 357 | type FFIStackFrameTuple = 358 | #(Int, #(String, String, Int, String, Int)) 359 | 360 | fn list_at(in list: List(a), get index: Int) -> Result(a, Nil) { 361 | case index >= 0 { 362 | True -> 363 | list 364 | |> list.drop(index) 365 | |> list.first 366 | False -> Error(Nil) 367 | } 368 | } 369 | 370 | @external(erlang, "stacky_ffi", "stacky_erlang_stack_trace") 371 | fn stacky_erlang_stack_trace() -> #(a, List(FFIStackFrameTuple)) 372 | 373 | @external(erlang, "stacky_ffi", "stacky_erlang_call_and_catch_panics") 374 | fn stacky_erlang_call_and_catch_panics( 375 | fun: fn() -> a, 376 | ) -> Result(a, #(reason, List(FFIStackFrameTuple))) 377 | 378 | /// This is a library and the main function 379 | /// exists as a placeholder if called as a function 380 | /// from the command line. 381 | /// 382 | pub fn main() { 383 | io.println("\nFor example stack traces, run:\n") 384 | io.println(" gleam run --module stacky/internal/example\n") 385 | io.println("...or...\n") 386 | io.println( 387 | " gleam run --module stacky/internal/sub_dir/example_in_sub_dir\n", 388 | ) 389 | io.println("...or...\n") 390 | io.println(" gleam run --module my_gleam_module\n") 391 | } 392 | -------------------------------------------------------------------------------- /src/stacky/internal/examples/example_1.gleam: -------------------------------------------------------------------------------- 1 | import stacky 2 | 3 | pub fn main() { 4 | stacky.trace() 5 | |> stacky.print_trace 6 | } 7 | -------------------------------------------------------------------------------- /src/stacky/internal/examples/example_2.gleam: -------------------------------------------------------------------------------- 1 | import gleam/io 2 | import pprint 3 | import stacky 4 | 5 | pub fn main() { 6 | let stacktrace = stacky.trace() 7 | 8 | io.print("\n") 9 | 10 | io.println("Trace to string:") 11 | stacktrace 12 | |> stacky.print_trace 13 | 14 | io.print("\n") 15 | 16 | io.println("Frame:") 17 | let stackframe = 18 | stacktrace 19 | // get the top most stack frame 20 | |> stacky.frame(0) 21 | |> pprint.debug 22 | 23 | io.print("\n") 24 | 25 | io.print("Qualified module name: ") 26 | stackframe 27 | |> stacky.qualified_module_name 28 | |> io.println 29 | 30 | io.print("\n") 31 | 32 | io.println("Frame with context:") 33 | stackframe 34 | |> stacky.print_frame_with(context: #("my_context")) 35 | 36 | io.print("\n") 37 | 38 | io.println("Internal stack frame:") 39 | stacktrace 40 | |> pprint.debug 41 | } 42 | -------------------------------------------------------------------------------- /src/stacky/internal/examples/example_3.gleam: -------------------------------------------------------------------------------- 1 | import stacky/internal/examples/example_3/module_with_stacky_call 2 | 3 | pub fn main() { 4 | module_with_stacky_call.some_function_that_calls_stacky() 5 | } 6 | -------------------------------------------------------------------------------- /src/stacky/internal/examples/example_3/module_with_stacky_call.gleam: -------------------------------------------------------------------------------- 1 | import pprint 2 | import stacky 3 | 4 | pub fn some_function_that_calls_stacky() { 5 | let stack = 6 | stacky.trace() 7 | // See the strack trace: 8 | |> pprint.debug 9 | 10 | let frame = 11 | stack 12 | |> stacky.frame(0) 13 | // See the top most stack frame, from this call site: 14 | |> pprint.debug 15 | 16 | frame 17 | |> stacky.qualified_module_name 18 | // See the current qualified module name, from this call site: 19 | |> pprint.debug 20 | 21 | frame 22 | |> stacky.function_name 23 | // See the current function name, from this call site: 24 | |> pprint.debug 25 | 26 | // prints gleam module.function and erlang with line number to stdout 27 | frame 28 | |> stacky.print_frame 29 | } 30 | -------------------------------------------------------------------------------- /src/stacky/internal/examples/example_4.gleam: -------------------------------------------------------------------------------- 1 | import gleam/io 2 | import gleam/string 3 | import stacky 4 | 5 | pub fn main() { 6 | string.inspect(["hallo"]) 7 | case happy_function |> stacky.call_and_catch_panics { 8 | Ok(_) -> Nil 9 | Error(stack_trace) -> stack_trace |> stacky.print_trace 10 | } 11 | 12 | case panic_function |> stacky.call_and_catch_panics { 13 | Ok(_) -> Nil 14 | Error(stack_trace) -> stack_trace |> stacky.print_trace 15 | } 16 | } 17 | 18 | fn happy_function() { 19 | io.print("\n") 20 | io.println("I'm a happy function and thus not going to crash!") 21 | } 22 | 23 | fn panic_function() { 24 | io.print("\n") 25 | io.println("I'm a sad function and thus I am going to crash:") 26 | panic as "panic at the disco" 27 | } 28 | -------------------------------------------------------------------------------- /src/stacky/internal/examples/example_readme.gleam: -------------------------------------------------------------------------------- 1 | import gleam/io 2 | import stacky 3 | 4 | pub fn main() { 5 | let stack_trace = stacky.trace() 6 | 7 | io.print("\n") 8 | 9 | io.println("Trace to string:") 10 | stack_trace 11 | |> stacky.print_trace 12 | 13 | io.print("\n") 14 | 15 | let stack_frame = 16 | stack_trace 17 | |> stacky.frame(0) 18 | 19 | io.println("Frame with context:") 20 | stack_frame 21 | |> stacky.print_frame_with(context: #("my_context")) 22 | } 23 | -------------------------------------------------------------------------------- /src/stacky_ffi.erl: -------------------------------------------------------------------------------- 1 | -module(stacky_ffi). 2 | 3 | -export([stacky_erlang_stack_trace/0, stacky_erlang_call_and_catch_panics/1]). 4 | 5 | enumerate_reversed(List) -> 6 | I = length(List), 7 | enumerate_reversed(I, 1, List). 8 | 9 | enumerate_reversed(I, S, List) -> 10 | {List1, _ } = lists:mapfoldl(fun(T, Acc) -> {{Acc, T}, Acc-S} end, I, List), 11 | List1. 12 | 13 | stacky_erlang_call_and_catch_panics(Function) when is_function(Function) -> 14 | try 15 | {ok, Function()} 16 | catch 17 | _Class:Reason:Stacktrace -> {error, handle_full_stack_trace({Reason, Stacktrace})} 18 | end. 19 | 20 | stacky_erlang_stack_trace() -> 21 | FullStackTrace = 22 | try 23 | throw(trace) 24 | catch 25 | _Class:Reason:Stacktrace -> {Reason, Stacktrace} 26 | end, 27 | handle_full_stack_trace(FullStackTrace). 28 | 29 | handle_full_stack_trace({Reason, FullStackTrace}) -> 30 | [_FfiCallFrame, _StackyCallFrame | RestStacktrace] = FullStackTrace, 31 | StackTrace = lists:map(fun(StackFrame) -> 32 | case StackFrame of 33 | {ModuleName, FunctionName, Arity, [{file, Filename}, {line, LineNumber}]} -> 34 | { 35 | atom_to_binary(ModuleName), 36 | atom_to_binary(FunctionName), 37 | Arity, 38 | iolist_to_binary(Filename), 39 | LineNumber}; 40 | {ModuleName, FunctionName, Arity, []} -> 41 | {atom_to_binary(ModuleName), 42 | atom_to_binary(FunctionName), 43 | Arity, 44 | <<"">>, 45 | -1}; 46 | Other -> 47 | erlang:display(Other), 48 | % TODO: pass this through to the gleam layer and somehow dump the information on the user 49 | % through Results 50 | % Also wrap everything here in try catch and return it as a result 51 | % to be handled by stacky lib 52 | throw("unexpected stack frame data - please report this as a potential bug") 53 | end 54 | end, 55 | RestStacktrace), 56 | {Reason, enumerate_reversed(StackTrace)}. 57 | -------------------------------------------------------------------------------- /test/stacky_test.gleam: -------------------------------------------------------------------------------- 1 | import gleeunit 2 | import gleeunit/should 3 | import stacky.{ 4 | ErlangFileName, ErlangLineNumber, ErlangModuleName, FunctionArity, 5 | FunctionName, StackFrame, StackIndex, StackTrace, 6 | } 7 | 8 | pub fn main() { 9 | gleeunit.main() 10 | } 11 | 12 | const erlang_file_name = "stacky/build/dev/erlang/stacky/_gleam_artefacts/stacky_test.erl" 13 | 14 | pub fn stacky_test() { 15 | let expected_trace = 16 | StackTrace("Trace", [ 17 | StackFrame( 18 | StackIndex(6), 19 | ErlangModuleName("stacky_test"), 20 | FunctionName("stacky_test"), 21 | FunctionArity(0), 22 | ErlangFileName( 23 | "stacky/build/dev/erlang/stacky/_gleam_artefacts/stacky_test.erl", 24 | ), 25 | ErlangLineNumber(65), 26 | ), 27 | StackFrame( 28 | StackIndex(5), 29 | ErlangModuleName("eunit_test"), 30 | FunctionName("-mf_wrapper/2-fun-0-"), 31 | FunctionArity(2), 32 | ErlangFileName("eunit_test.erl"), 33 | ErlangLineNumber(274), 34 | ), 35 | StackFrame( 36 | StackIndex(4), 37 | ErlangModuleName("eunit_test"), 38 | FunctionName("run_testfun"), 39 | FunctionArity(1), 40 | ErlangFileName("eunit_test.erl"), 41 | ErlangLineNumber(72), 42 | ), 43 | StackFrame( 44 | StackIndex(3), 45 | ErlangModuleName("eunit_proc"), 46 | FunctionName("run_test"), 47 | FunctionArity(1), 48 | ErlangFileName("eunit_proc.erl"), 49 | ErlangLineNumber(544), 50 | ), 51 | StackFrame( 52 | StackIndex(2), 53 | ErlangModuleName("eunit_proc"), 54 | FunctionName("with_timeout"), 55 | FunctionArity(3), 56 | ErlangFileName("eunit_proc.erl"), 57 | ErlangLineNumber(369), 58 | ), 59 | StackFrame( 60 | StackIndex(1), 61 | ErlangModuleName("eunit_proc"), 62 | FunctionName("handle_test"), 63 | FunctionArity(2), 64 | ErlangFileName("eunit_proc.erl"), 65 | ErlangLineNumber(527), 66 | ), 67 | ]) 68 | 69 | let expected_frame = 70 | StackFrame( 71 | StackIndex(6), 72 | ErlangModuleName("stacky_test"), 73 | FunctionName("stacky_test"), 74 | FunctionArity(0), 75 | ErlangFileName(erlang_file_name), 76 | ErlangLineNumber(65), 77 | ) 78 | 79 | // The ErlangFileName is relative to wherever this test runs so we need to replace it 80 | let stack_trace = stacky.trace() 81 | let assert StackTrace(reason: reason, frames: [head_frame, ..frames]) = 82 | stack_trace 83 | let head_frame = 84 | StackFrame(..head_frame, erlang_file_name: ErlangFileName(erlang_file_name)) 85 | let stack_trace = StackTrace(reason: reason, frames: [head_frame, ..frames]) 86 | 87 | let stack_frame = 88 | stack_trace 89 | |> stacky.frame(0) 90 | 91 | let gleam_module_name = 92 | stack_frame 93 | |> stacky.qualified_module_name 94 | 95 | stack_trace 96 | |> should.equal(expected_trace) 97 | 98 | stack_frame 99 | |> should.equal(expected_frame) 100 | 101 | gleam_module_name 102 | |> should.equal("stacky_test") 103 | } 104 | --------------------------------------------------------------------------------