Load timer #405

Tearran · 2025-02-01T20:27:01Z

Description

refinement of #326

Added a Timer function to help identify sections that are slow and may need optimization or separation to improve performance.

./tools/armbian-config-dev and ./bin/armbian-config

Initializing script: 0 seconds
Setting base data: 0 seconds
The current Armbian 24.8.4 stable (bookworm) is supported.: 4 seconds
Loaded Runtime variables...: 0 seconds
Loaded Dialog...: 0 seconds
Loaded Docs...: 0 seconds
Loaded System helpers...: 0 seconds
Loaded Network helpers...: 0 seconds
Loaded Software helpers...: 0 seconds

note '--api' '--docs' and '! -t =$0" do not output timer results see

./bin/armbian-config --api set_checkpoint help

Usage: set_checkpoint <start|stop|mark|show> [description] [show]
Commands:
  start              Start the timer.
  stop               Stop the timer.
  mark [description] [time] Mark a checkpoint with an optional description and an optional flag to show the output.
  show               Show the total elapsed time and checkpoints.

Issue reference:
[Bug]: sanitize_input #324
function raceing
Partly addresses UX vs Non interactive mode use

Implementation Details

added variable checks for UX mode to help separate from the non interactive modes

Checklist

My code follows the style guidelines of this project
I have performed a self-review of my code
I have ensured that my changes do not introduce new warnings or errors
No new external dependencies are included
Changes have been tested and verified
I have included necessary metadata in the code, including associative arrays

dimitry-ishenko · 2025-02-02T22:58:12Z

@Tearran IMHO it would be PITA to maintain two copies of armbian-config.

What about using an env var (eg, ARMBIAN_CONFIG_DEBUG or just DEBUG) to show the timing info? Eg,

DEBUG=1 ./bin/armbian-config ...

Then in message_checkpoint.sh you can add something like this at the end:

# disable set_checkpoint if DEBUG has not been defined
[[ -n "$DEBUG" ]] || eval "set_checkpoint(){ :; }"

igorpecovnik · 2025-02-03T10:55:04Z

IMHO it would be PITA to maintain two copies

Yes, I would also propose to have one.

remove redundant file

dimitry-ishenko

@Tearran I was under the impression that we only wanted timing info for debugging purposes. I kinda like that it's printed every time, but I don't know if there might be objections in terms of performance or some other reasons.

bin/armbian-config

tools/modules/initialize/message_checkpoint.sh

Tearran · 2025-02-05T20:32:03Z

What about using an env var (eg, ARMBIAN_CONFIG_DEBUG or just DEBUG) to show the timing info?

@dimitry-ishenko I am not opposed to using a DEBUG environment variable in general. However, I would like to clarify that the messages displayed are not meant for debugging purposes and are not being introduced with this PR. These messages were previously implemented to improve the user experience by indicating that the application is working and not frozen.

In other words, this PR does not address bugs. Rather, it outlines the expected parsing load time limitations due to the linear nature of bash, such as function variable racing and other inherent constraints.

The addition of the timestamp is multifaceted. Firstly, IMHO it is important to recognize the limitations of bash, so that expected limitations are not identified as bugs. Showing loading time addresses this by clearly showing expected behavior. For example, 4 seconds may be undesirable but it is not a bug. By providing these user-facing messages, we aim to enhance user experience by transparently communicating the application's activity, thus avoiding any misconceptions of the application being unresponsive.

dimitry-ishenko · 2025-02-05T21:30:36Z

@dimitry-ishenko I am not opposed to using a DEBUG environment variable in general. However, I would like to clarify that the messages displayed are not meant for debugging purposes and are not being introduced with this PR. These messages were previously implemented to improve the user experience by indicating that the application is working and not frozen.

@Tearran sorry, not sure why I got the idea this was for debugging. Thanks for the clear explanation, it makes sense.

dimitry-ishenko · 2025-02-06T17:15:54Z

bin/armbian-config


 [[ -d "$script_dir/../tools" ]] && tools_dir="$script_dir/../tools"
 [[ ! -d "$script_dir/../lib" && -n "$tools_dir" ]] && die -e "Please run\nbash "$tools_dir/config-assemble.sh" to build the lib directory\n"

+
+DEV=$([[ "$(basename "$0")" =~ .*"-dev"$ ]] && echo "true")


[[ "$(basename "$0")" =~ -dev$ ]] && DEV="true"

It appears I must have been really indecisive about that one or the subshell and then .. squirrel .. Thank you for catching that. Line 27 Subshell FTW I presume? :) but really my be best to drop $DEV stuff from this PR for now

your DEBUG=1 ./bin/armbian-config suggestion A+

Tearran · 2025-02-07T08:54:59Z

Sorry, not sure why I got the idea this was for debugging.

no need to apologize, Debugging is a reasonable conclusion; the armbian-config-dev option does resemble debugging. and set_checkpoint option show is intended to serve a debugging purpose , That being said the Discussion of Debugging is valid while it is mindfully relative and IMO is applicable here

bin/armbian-config

Tearran · 2025-02-08T06:59:12Z

Added alias/helper checkpoint with a debug option.
Use in file: checkpoint debug "Starting --api options"
For more, see checkpoint help (set_checkpoint help debug appended).
sudo ./bin/armbian-config --api checkpoint help

Usage: set_checkpoint <start|stop|mark|show> [description] [show]
Commands:
  start              Start the timer.
  stop               Stop the timer.
  mark [description] [time] Mark a checkpoint with an optional description and an optional flag to show the output.
  show               Show the total elapsed time and checkpoints.
  debug              DEBUG checkpoint message

Debug level 2 shows like UX mode, printing each step.

Other DEBUG levels (DEBUG=1, DEBUG=anything) default to set_checkpoint show.

This section doe not print with other DEBUG values
sudo DEBUG=2 ./bin/armbian-config --api checkpoint help

Initializing script                     0 seconds
Loaded Runtime variables...             4 seconds
The current Armbian 24.8.4 stable (bookworm) is supported.           0 seconds
Loaded Dialog...                        0 seconds
Loaded Docs...                          0 seconds
Loaded System helpers...                1 second
Loaded Network helpers...               0 seconds
Loaded Software helpers...              0 seconds
Loaded Runtime conditions...            5 seconds
DEBUG Messages on                       0 seconds
Starting --api options                  0 seconds

The normal output if any from the command line options.

Following shows if debug has a value [[ -n $DEBUG ]]

Exiting --api                           0 seconds
Total elapsed time            : 10 seconds
Initializing script           : 0 seconds
Loaded Runtime variables...   : 4 seconds
The current Armbian 24.8.4 stable (bookworm) is supported.: 0 seconds
Loaded Dialog...              : 0 seconds
Loaded Docs...                : 0 seconds
Loaded System helpers...      : 1 second
Loaded Network helpers...     : 0 seconds
Loaded Software helpers...    : 0 seconds
Loaded Runtime conditions...  : 5 seconds
DEBUG Messages on             : 0 seconds
Starting --api options        : 0 seconds
Exiting --api                 : 0 seconds

Tearran added 3 commits February 1, 2025 20:04

add check point timer module

2edc75c

updated main to se checkpoint timer

622ead6

cp armbian-config to tools/armbian-config-dev

651f73b

github-actions bot added the size/large PR with 250 lines or more label Feb 1, 2025

fix style

4763901

Tearran mentioned this pull request Feb 1, 2025

Non interactive modes ( [Bug]: sanitize_input #324 ) #326

Open

Tearran requested a review from dimitry-ishenko February 1, 2025 20:47

Tearran marked this pull request as ready for review February 1, 2025 20:48

igorpecovnik added 02 Milestone: First quarter release Needs review Seeking for review labels Feb 3, 2025

Delete tools/armbian-config-dev

c73aba9

remove redundant file

github-actions bot added size/medium PR with more then 50 and less then 250 lines and removed size/large PR with 250 lines or more labels Feb 5, 2025

Tearran added 2 commits February 5, 2025 06:08

fix conflict

3325367

part fix conflict

3cc05d0

github-actions bot added size/large PR with 250 lines or more and removed size/medium PR with more then 50 and less then 250 lines labels Feb 5, 2025

Merge branch 'main' into load_timer

7056fa8

github-actions bot added size/medium PR with more then 50 and less then 250 lines and removed size/large PR with 250 lines or more labels Feb 5, 2025

dimitry-ishenko previously approved these changes Feb 5, 2025

View reviewed changes

bin/armbian-config Outdated Show resolved Hide resolved

tools/modules/initialize/message_checkpoint.sh Outdated Show resolved Hide resolved

tools/modules/initialize/message_checkpoint.sh Outdated Show resolved Hide resolved

dimitry-ishenko reviewed Feb 5, 2025

View reviewed changes

tools/modules/initialize/message_checkpoint.sh Outdated Show resolved Hide resolved

update

9ed2c23

Tearran dismissed dimitry-ishenko’s stale review via 9ed2c23 February 6, 2025 06:18

dimitry-ishenko reviewed Feb 6, 2025

View reviewed changes

rfine set_checkpoint show to use for debug

41d77c9

Merge branch 'main' into load_timer

22c3c48

Tearran and others added 2 commits February 7, 2025 09:07

rm consept

c18a50e

Merge branch 'main' into load_timer

59e2002

dimitry-ishenko reviewed Feb 7, 2025

View reviewed changes

bin/armbian-config Outdated Show resolved Hide resolved

Tearran and others added 3 commits February 8, 2025 04:57

fix typo

e43bb8e

Merge branch 'main' into load_timer

2c1ad01

Added alias/helper checkpoint with a debug option.

c51a575

Tearran added 3 commits February 8, 2025 07:12

added checkpoint to --api --cmd

49622a7

fix style

f34bb96

explore testcase error

9b8fbe1

github-actions bot added the Unit Tests label Feb 8, 2025

Tearran added 2 commits February 8, 2025 08:23

revert test case

d098af4

explore 2

4d6ab8b

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Load timer #405

Load timer #405

Tearran commented Feb 1, 2025 •

edited

Loading

dimitry-ishenko commented Feb 2, 2025 •

edited

Loading

igorpecovnik commented Feb 3, 2025

dimitry-ishenko left a comment •

edited

Loading

Tearran commented Feb 5, 2025

dimitry-ishenko commented Feb 5, 2025

dimitry-ishenko Feb 6, 2025 •

edited

Loading

Tearran Feb 7, 2025 •

edited

Loading

Tearran commented Feb 7, 2025

Tearran commented Feb 8, 2025

Load timer #405

Are you sure you want to change the base?

Load timer #405

Conversation

Tearran commented Feb 1, 2025 • edited Loading

Description

Implementation Details

Checklist

dimitry-ishenko commented Feb 2, 2025 • edited Loading

igorpecovnik commented Feb 3, 2025

dimitry-ishenko left a comment • edited Loading

Choose a reason for hiding this comment

Tearran commented Feb 5, 2025

dimitry-ishenko commented Feb 5, 2025

dimitry-ishenko Feb 6, 2025 • edited Loading

Choose a reason for hiding this comment

Tearran Feb 7, 2025 • edited Loading

Choose a reason for hiding this comment

Tearran commented Feb 7, 2025

Tearran commented Feb 8, 2025

Tearran commented Feb 1, 2025 •

edited

Loading

dimitry-ishenko commented Feb 2, 2025 •

edited

Loading

dimitry-ishenko left a comment •

edited

Loading

dimitry-ishenko Feb 6, 2025 •

edited

Loading

Tearran Feb 7, 2025 •

edited

Loading