Skip to content
This repository has been archived by the owner on Feb 26, 2024. It is now read-only.

feat: allow logs to be written to a file by providing the --logging.file argument #4195

Merged
merged 66 commits into from
Jun 27, 2023
Merged

feat: allow logs to be written to a file by providing the --logging.file argument #4195

merged 66 commits into from
Jun 27, 2023

Commits on Mar 8, 2023

  1. Basic implementation of logging to file

    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    c7f86d3 View commit details
    Browse the repository at this point in the history

  2. Simplify logging

    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    54b85c5 View commit details
    Browse the repository at this point in the history

  3. Simplify regex for inserting timestamps

    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    b0ca2e9 View commit details
    Browse the repository at this point in the history

  4. Remove --timestamps argument

    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    a397b6f View commit details
    Browse the repository at this point in the history

  5. Use a persistent filehandle instead of calling 'appendFile' each tile… 

    … a log is written
    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    0f13a36 View commit details
    Browse the repository at this point in the history

  6. Introduce tests for logger, fail validation if path is not w 

    ritable
    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    b206a42 View commit details
    Browse the repository at this point in the history

  7. Update tests to use per-test log files

    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    d1ec4fe View commit details
    Browse the repository at this point in the history

  8. Resolve invalid path

    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    feb57bd View commit details
    Browse the repository at this point in the history

  9. In windows, use reserved path 'c:\NUL' for invalid path

    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    0b8673f View commit details
    Browse the repository at this point in the history

  10. Revert changes and just await the rejection

    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    6d73be8 View commit details
    Browse the repository at this point in the history

  11. Let's do use the NUL workaround for windows

    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    8b4ae04 View commit details
    Browse the repository at this point in the history

  12. Attempt to get tests to passing state

    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    4b6159e View commit details
    Browse the repository at this point in the history

  13. Use current working directory as invalid file path

    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    e2db28f View commit details
    Browse the repository at this point in the history

  14. Tidy up logging

    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    d2db1a4 View commit details
    Browse the repository at this point in the history

  15. Create file when validating logging.file path is writable.

    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    4e64fc7 View commit details
    Browse the repository at this point in the history

  16. Move logger into cli project, allow caller to close underlying fileha… 

    …ndle
    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    8423a65 View commit details
    Browse the repository at this point in the history

  17. Revert unrelated changes, fix flaky initialisation of logger

    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    fcf39ed View commit details
    Browse the repository at this point in the history

  18. Fix error when no logging config exists

    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    22ec214 View commit details
    Browse the repository at this point in the history

  19. Switch to use 'fs.openSync()' instead of 'fs.writeSync()' because win… 

    …dows won't if the content is empty :(
    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    37e1616 View commit details
    Browse the repository at this point in the history

  20. Work in progress. Move logger into @ganache/utils, resolve filehandle… 

    … within logging-options.
    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    44a7107 View commit details
    Browse the repository at this point in the history

  21. Improve tests, implementation, support for filecoin

    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    b02821d View commit details
    Browse the repository at this point in the history

  22. Finish tidying up implementation. Broke the console.log tests though … 

    …¯\_(ツ)_/¯
    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    4e7ddd6 View commit details
    Browse the repository at this point in the history

  23. Support setting both file and logger, refactor tangentially related test

    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    f9aac47 View commit details
    Browse the repository at this point in the history

  24. tidy up implementation, fix tests, don't accept filehandle as logging… 

    ….file because then it's impossible for us to now whether we should close it
    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    6cc6fb2 View commit details
    Browse the repository at this point in the history

  25. Update package-lock.json - adds reference to @ganache/utils

    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    303330d View commit details
    Browse the repository at this point in the history

  26. Upgrade @ganache/utils

    @jeffsmale90
    jeffsmale90 committed Mar 8, 2023
    Configuration menu
    Copy the full SHA
    7edf108 View commit details
    Browse the repository at this point in the history

Commits on Mar 9, 2023

  1. Update reference to Logger type in tests

    @jeffsmale90
    jeffsmale90 committed Mar 9, 2023
    Configuration menu
    Copy the full SHA
    ca8f581 View commit details
    Browse the repository at this point in the history

  2. Modify 'EPERM' test to support Windows (who does some freaky stuff wh… 

    …en a directory is opened for writing)
    @jeffsmale90
    jeffsmale90 committed Mar 9, 2023
    Configuration menu
    Copy the full SHA
    04a0674 View commit details
    Browse the repository at this point in the history

  3. Pin @types/sinon

    @jeffsmale90
    jeffsmale90 committed Mar 9, 2023
    Configuration menu
    Copy the full SHA
    8352f82 View commit details
    Browse the repository at this point in the history

  4. Add test to ensure that resolved file descriptor is append only

    @jeffsmale90
    jeffsmale90 committed Mar 9, 2023
    Configuration menu
    Copy the full SHA
    5a556d6 View commit details
    Browse the repository at this point in the history

  5. Fix failing tests

    @jeffsmale90
    jeffsmale90 committed Mar 9, 2023
    Configuration menu
    Copy the full SHA
    1ff9eb9 View commit details
    Browse the repository at this point in the history

  6. Merge remote-tracking branch 'origin/feat/logging' into feat/logging

    @jeffsmale90
    jeffsmale90 committed Mar 9, 2023
    Configuration menu
    Copy the full SHA
    d08ff26 View commit details
    Browse the repository at this point in the history

  7. Add test to ensure that provider.disconnect() closes the file descriptor

    @jeffsmale90
    jeffsmale90 committed Mar 9, 2023
    Configuration menu
    Copy the full SHA
    b577089 View commit details
    Browse the repository at this point in the history

Commits on Mar 12, 2023

  1. Fix @jeffsmale90's broken regex :) 

    Co-authored-by: cds-amal <[email protected]>
    @jeffsmale90 @cds-amal
    jeffsmale90 and cds-amal authored Mar 12, 2023
    Configuration menu
    Copy the full SHA
    cc87e1e View commit details
    Browse the repository at this point in the history

  2. Fix @jeffsmale90's broken regex :) 

    Co-authored-by: cds-amal <[email protected]>
    @jeffsmale90 @cds-amal
    jeffsmale90 and cds-amal authored Mar 12, 2023
    Configuration menu
    Copy the full SHA
    0d445cb View commit details
    Browse the repository at this point in the history

  3. Fix @jeffsmale90's broken regex :) 

    Co-authored-by: cds-amal <[email protected]>
    @jeffsmale90 @cds-amal
    jeffsmale90 and cds-amal authored Mar 12, 2023
    Configuration menu
    Copy the full SHA
    a235c7a View commit details
    Browse the repository at this point in the history

Commits on Mar 15, 2023

  1. Comments and refactor from review

    @jeffsmale90
    jeffsmale90 committed Mar 15, 2023
    Configuration menu
    Copy the full SHA
    838b9dc View commit details
    Browse the repository at this point in the history

  2. Oops - messed up comments

    @jeffsmale90
    jeffsmale90 committed Mar 15, 2023
    Configuration menu
    Copy the full SHA
    ff67775 View commit details
    Browse the repository at this point in the history

Commits on Mar 28, 2023

  1. Use WriteStream instead of appending to an open filehandle directly. … 

    …Tidy up some tests, and Logger type definitions..
    @jeffsmale90
    jeffsmale90 committed Mar 28, 2023
    Configuration menu
    Copy the full SHA
    2af6a26 View commit details
    Browse the repository at this point in the history

  2. Fix up my mistakes

    @jeffsmale90
    jeffsmale90 committed Mar 28, 2023
    Configuration menu
    Copy the full SHA
    faad325 View commit details
    Browse the repository at this point in the history

  3. Close file handle correctly in test

    @jeffsmale90
    jeffsmale90 committed Mar 28, 2023
    Configuration menu
    Copy the full SHA
    33849ce View commit details
    Browse the repository at this point in the history

Commits on Mar 29, 2023

  1. Refactor logging options tests, correctly remove fixture files

    @jeffsmale90
    jeffsmale90 committed Mar 29, 2023
    Configuration menu
    Copy the full SHA
    67d4db3 View commit details
    Browse the repository at this point in the history

  2. Close test log files correctly in logging-options tests

    @jeffsmale90
    jeffsmale90 committed Mar 29, 2023
    Configuration menu
    Copy the full SHA
    685b6f9 View commit details
    Browse the repository at this point in the history

  3. Remove unnecessary import

    @jeffsmale90
    jeffsmale90 authored Mar 29, 2023
    Configuration menu
    Copy the full SHA
    acc4bef View commit details
    Browse the repository at this point in the history

Commits on Apr 13, 2023

  1. Don't await getProvider() twice 

    Co-authored-by: David Murdoch <[email protected]>
    @jeffsmale90 @davidmurdoch
    jeffsmale90 and davidmurdoch authored Apr 13, 2023
    Configuration menu
    Copy the full SHA
    12f3bd1 View commit details
    Browse the repository at this point in the history

Commits on Apr 17, 2023

  1. change 'writing' to `'write' because it makes sense this way 

    Co-authored-by: David Murdoch <[email protected]>
    @jeffsmale90 @davidmurdoch
    jeffsmale90 and davidmurdoch authored Apr 17, 2023
    Configuration menu
    Copy the full SHA
    247454c View commit details
    Browse the repository at this point in the history

  2. Refinement as per PR

    @jeffsmale90
    jeffsmale90 committed Apr 17, 2023
    Configuration menu
    Copy the full SHA
    daa040a View commit details
    Browse the repository at this point in the history

  3. New line at end of tsconfig files

    @jeffsmale90
    jeffsmale90 committed Apr 17, 2023
    Configuration menu
    Copy the full SHA
    295ab1a View commit details
    Browse the repository at this point in the history

  4. Assert that logs are appended to an existing file. Refactor logging-o… 

    …ptions tests to reuse asserLogLine logic. Fix test that covers file access error (that now includes the useful error message).
    @jeffsmale90
    jeffsmale90 committed Apr 17, 2023
    Configuration menu
    Copy the full SHA
    eb8d2b8 View commit details
    Browse the repository at this point in the history

  5. Use tmp-promise to resolve temporary files for use in tests

    @jeffsmale90
    jeffsmale90 committed Apr 17, 2023
    Configuration menu
    Copy the full SHA
    970fb76 View commit details
    Browse the repository at this point in the history

  6. Merge branch 'develop' into feat/logging

    @jeffsmale90
    jeffsmale90 committed Apr 17, 2023
    Configuration menu
    Copy the full SHA
    ec7d5a3 View commit details
    Browse the repository at this point in the history

  7. Fix baseLogger

    @jeffsmale90
    jeffsmale90 committed Apr 17, 2023
    Configuration menu
    Copy the full SHA
    d47acdd View commit details
    Browse the repository at this point in the history

  8. Support CRLF and LF line endings in multiline log messages

    @jeffsmale90
    jeffsmale90 committed Apr 17, 2023
    Configuration menu
    Copy the full SHA
    39a7adb View commit details
    Browse the repository at this point in the history

  9. Use tmp-promise in 'closes the logging fileDescriptor' test

    @jeffsmale90
    jeffsmale90 committed Apr 17, 2023
    Configuration menu
    Copy the full SHA
    180b9e8 View commit details
    Browse the repository at this point in the history

  10. Await tests that user tmp.with(File|Dir), remove thrown Error from te… 

    …st, fix incorrect test name
    @jeffsmale90
    jeffsmale90 committed Apr 17, 2023
    Configuration menu
    Copy the full SHA
    0a80a3e View commit details
    Browse the repository at this point in the history

  11. TIL: tmp.dir() only cleans up if the dir is empty. Some formatting fi… 

    …xes.
    @jeffsmale90
    jeffsmale90 committed Apr 17, 2023
    Configuration menu
    Copy the full SHA
    0fb659e View commit details
    Browse the repository at this point in the history

  12. Use unsafeCleanup to force tmp to remove the temp directory, even whe… 

    …n the log file is still in it.
    @jeffsmale90
    jeffsmale90 committed Apr 17, 2023
    Configuration menu
    Copy the full SHA
    0d7cb88 View commit details
    Browse the repository at this point in the history

Commits on Jun 19, 2023

  1. Don't explicitly unlink filepath, rely on tmp-promise to clean itself… 

    … up, add a comment explaining 'unsafeCleanup'
    @jeffsmale90
    jeffsmale90 committed Jun 19, 2023
    Configuration menu
    Copy the full SHA
    4a76b48 View commit details
    Browse the repository at this point in the history

Commits on Jun 20, 2023

  1. Update src/chains/ethereum/options/src/logging-options.ts 

    Co-authored-by: David Murdoch <[email protected]>
    @jeffsmale90 @davidmurdoch
    jeffsmale90 and davidmurdoch authored Jun 20, 2023
    Configuration menu
    Copy the full SHA
    c1d9565 View commit details
    Browse the repository at this point in the history

  2. Move dep to devdep, fix EOL discrepancy in link-ts-references

    @jeffsmale90
    jeffsmale90 committed Jun 20, 2023
    Configuration menu
    Copy the full SHA
    7671bea View commit details
    Browse the repository at this point in the history

Commits on Jun 21, 2023

  1. Merge branch 'develop' into feat/logging

    @jeffsmale90
    jeffsmale90 authored Jun 21, 2023
    Configuration menu
    Copy the full SHA
    084b583 View commit details
    Browse the repository at this point in the history

Commits on Jun 22, 2023

  1. Move tmp-promise to devDependencies

    @jeffsmale90
    jeffsmale90 committed Jun 22, 2023
    Configuration menu
    Copy the full SHA
    b52db3e View commit details
    Browse the repository at this point in the history

  2. Reorder deps, and fix package-locks

    @jeffsmale90
    jeffsmale90 committed Jun 22, 2023
    Configuration menu
    Copy the full SHA
    6a072f7 View commit details
    Browse the repository at this point in the history

Commits on Jun 26, 2023

  1. Merge branch 'develop' into feat/logging

    @davidmurdoch
    davidmurdoch authored Jun 26, 2023
    Configuration menu
    Copy the full SHA
    6d8cce1 View commit details
    Browse the repository at this point in the history

  2. Revert those silly package-lock files

    @jeffsmale90
    jeffsmale90 committed Jun 26, 2023
    Configuration menu
    Copy the full SHA
    2213061 View commit details
    Browse the repository at this point in the history

Commits on Jun 27, 2023

  1. Doing the tmp-promise shuffle

    @jeffsmale90
    jeffsmale90 committed Jun 27, 2023
    Configuration menu
    Copy the full SHA
    50a614c View commit details
    Browse the repository at this point in the history