Add input arguments to the applications #66

RodrigoATorres · 2020-04-22T21:09:21Z

Problem:
I felt that would be nice to have the possibility to have my browser, file explorer or VScode to open with the tabs I want, or in the folder I want, when restoring a session.
Saving that information automatically when saving a session looked like a hard tasks, and even harder to make it generic for all applications (maybe impossible).

Solution:
The workaround I found for these would be to enable user to manually put arguments on the json files to be passed as input arguments when starting the applications. Adding this functionality itself was not a problem, but an other issue came up:
When the session has more than one instance of the same application, it was impossible to tell which window of the application was opened with which input arguments (I could not find a way, at least).

To overcome that, bigger changes had to be done on the code. I created a function "_startAndWaitPrograms" that would, in case there were instances of the same applications with different input arguments, wait for the window of each instance of the application to open, before starting the other one. The new code is commented, in order to explain exactly how it is done.

How to use:
I tested the code with different applications,. To make use of the new functionality the field "executableArgs" has to be added to the json file.

For google chrome you can add:
"executableArgs": "--new-window gmail.com google.com"

For firefox:
"executableArgs": "--new-window gmail.com"
or (if you want to open more than one tab):
"executableArgs": " gmail.com google.com"

For nautilus:
"executableArgs": "/home/rodrigo/Desktop"

For Vscode:
"executableArgs": "/home/rodrigo/Desktop"

Concerns regarding the code:

There are some functions that are not being used anymore, as I adapted them into the "_startAndWaitPrograms" function. Should I remove them?
As the new function starts, waits and updates the windowId at the same time, I used the CFG.POLL_ALL_MAX_TIMEOUT value multiplied by 10. Should I create a new constant in config for that? Would that be a good value?
I understand that this changes require changes on the user usage and some changes on the structure of the code, so I understand if you decide not to incorporate them.
I didn't exactly understand the timeout set on "_waitForAllAppsToStart", so I didn't add it to the new function. Should I add it?

Best regards,

…n the correct order, making sure the windows will be moved to the right place when using custom input arguments

johannesjo · 2020-04-22T21:27:54Z

Wow! That's a big one. Thank you very much! I'll review it tomorrow.

Regarding your concerns:

There are some functions that are not being used anymore, as I adapted them into the "_startAndWaitPrograms" function. Should I remove them?

If it's not used then just delete it.

As the new function starts, waits and updates the windowId at the same time, I used the CFG.POLL_ALL_MAX_TIMEOUT value multiplied by 10. Should I create a new constant in config for that? Would that be a good value?

Yes. Makes sense!

I understand that this changes require changes on the user usage and some changes on the structure of the code, so I understand if you decide not to incorporate them.
I didn't exactly understand the timeout set on "_waitForAllAppsToStart", so I didn't add it to the new function. Should I add it?

Making changes to the existing behavior is indeed a bit problematic. There are lots of different scenarios (and the whole x11 stuff is used differently by every app) and chances are that we make the app unusable for some people. I much prefer to add this new behavior as an opt in, via a config flag or a command line argument or both than enforcing it on everybody. Would you be ok with that?

RodrigoATorres · 2020-04-22T21:40:37Z

Making changes to the existing behavior is indeed a bit problematic. There are lots of different scenarios (and the whole x11 stuff is used differently by every app) and chances are that we make the app unusable for some people. I much prefer to add this new behavior as an opt in, via a config flag or a command line argument or both than enforcing it on everybody. Would you be ok with that?

Sure, I think it makes perfect sense to use a flag or command line argument. The new code should work with the previous input, but I think it is a good idea to use a flag, at least until we have it well tested on different systems.

RodrigoATorres · 2020-04-27T13:07:36Z

Hey @johannesjo,
I just found a bug and fixed it. I was testing the code with input arguments and forgot to test it without them.
Sorry for that,
I will do more testing today.

johannesjo · 2020-04-27T13:09:38Z

@RodrigoATorres that's great!

Will you also make the adjustments to maintain compatibility?

RodrigoATorres · 2020-04-27T13:27:46Z

I can do that.

Right now, the new code is supposed to have backwards compatibility, it should work with previous input files.

But I will add a input flag, so if the the flag is not added, it will run exactly the previous code.
Is that what you were planning?

johannesjo · 2020-04-27T13:32:43Z

But I will add a input flag, so if the the flag is not added, it will run exactly the previous code.
Is that what you were planning?

This would be the best solution for now, I think. This way we can sure we don't break anything while also giving people the option to use it. If we don't encounter any issues, we can switch from opt in to opt out later.

…al code, or with the newly added, that allows adding input parameters to the window applications

RodrigoATorres · 2020-04-28T13:59:24Z

Doing more testing I saw that the code is presenting some instabilities.
I will have to spend some time trying to understand it.
Sorry for making the pull request without properly testing the code.

johannesjo · 2020-04-28T14:00:47Z

No worries :) Take your time!

…le files

RodrigoATorres · 2020-05-13T12:51:00Z

I have been using the new version, with the input arguments flag, daily for the past two weeks now.

I use always the same input, but it opens different software (like Vscode, chrome, firefox, nautilus) in 3 workspaces.

Most of the time it works as expected. When I run lwsm right after I login, sometimes it won't open some windows or won't move it to the second or third workspace. If I wait something like 10 or 20 seconds this problem won't happen. I tried the previous code on the same conditions and it seems to have the same behavior. I am not sure what causes that.

johannesjo · 2020-05-14T13:41:06Z

Thank you! I'll try to review this tomorrow!

johannesjo · 2020-05-15T14:34:16Z

src/index.ts

@@ -461,12 +471,141 @@ async function _startSessionPrograms(
    })
    .map(win => {
      win.instancesStarted += 1;
-      return startProgram(win.executableFile, win.desktopFilePath);
+      return startProgram(


If I am not mistaken this would lead toisAllowInputArgs being false to have no effect?

Sorry for taking so long to answer,
The code would start the programs with arguments, in case there were input arguments in the json file, if the isAllowInputArgs was set to false.
The effect isAllowInputArgs being set to false would be running _startSessionPrograms instead of _startAndWaitPrograms.
I believe I did that way because the input arguments themselves were not a big change on the code, that could lead to instabilities (like _startAndWaitPrograms).
But, now that you said, I agree that makes much more sense to remove them. I will just pass a empty string as an argument then, so the code will behave exactly as before.

johannesjo · 2020-05-15T14:35:26Z

src/index.ts

+  // Get the windowIds of all Ids that were previously opened in order to
+  // avoid these windows from being used isntead of the newly created windows
+  // (necessary for windows with custom input arguments)
+  var activeWindows = await getActiveWindowListFlow();


I would prefer using 'letorconst`.

I agree with you, will change them.

ChenSun-Phys · 2020-06-16T06:11:08Z

Just saw this implemented. What's the right way to invoke this behavior so that when my session is restored proper arguments will be passed along? For example, I have quite a few Okular instances open. When I restore my session, ideally the current open PDF's will be opened automatically. Thanks.

RodrigoATorres · 2020-06-17T20:44:38Z

Just saw this implemented. What's the right way to invoke this behavior so that when my session is restored proper arguments will be passed along? For example, I have quite a few Okular instances open. When I restore my session, ideally the current open PDF's will be opened automatically. Thanks.

This PR does not generate the input arguments automatically, you have to do it manually editing the json files.
To add it manually you can edit the saved json file and add the executableArgs field object of the corresponding window.

For google chrome you can add:
"executableArgs": "--new-window gmail.com google.com"

For firefox:
"executableArgs": "--new-window gmail.com"
or (if you want to open more than one tab):
"executableArgs": " gmail.com google.com"

For nautilus:
"executableArgs": "/home/rodrigo/Desktop"

For Vscode:
"executableArgs": "/home/rodrigo/Desktop"

Following are samples of how the json should look for Google-chrome and Vscode.

        {
          "windowId": "0x2c0000b",
          ...
          "simpleName": "Google-chrome",
          "executableFile": "google-chrome.desktop",
          "desktopFilePath": "/usr/share/applications/google-chrome.desktop",
          "executableArgs": "--new-window gmail.com"
        },

        {
          "windowId": "0x2e00001",
          ...
          "simpleName": "Code",
          "executableFile": "code.desktop",
          "desktopFilePath": "/usr/share/applications/code.desktop",
          "executableArgs": "/path/to/you/code"
        },

ChenSun-Phys · 2020-06-18T19:35:15Z

sorry if i would like to help test, how am I supposed to install the feature branch from RodrigoATorres's repository? I assume it's not pushed to npm source given it's not merged yet? Thanks.

johannesjo · 2020-06-18T20:00:15Z

@chensun-hep you should be able to do the following:

git clone https://github.com/RodrigoATorres/linux-window-session-manager some-folder
cd some-folder
yarn # or npm i should also work

node cmd.js save
node cmd.js restore

Not sure if the fork is up to date, but it should at least contain the state visible here.

…ons to let

…ed session

… flag

RodrigoATorres · 2020-09-07T16:10:38Z

I have just updated the code with the changes you requested.
I also updated README to include instructions on how to use it and included an empty "executableArgs" to the json file when saving a session, to facilitate its edition.

johannesjo · 2020-09-07T18:22:35Z

Thanks. I'll try to review this, this weekend again.

johannesjo · 2020-09-13T15:53:59Z

Sorry. I had a very busy weekend. I will try to do this on the next one. Sorry for the delay :-/

johannesjo · 2021-02-11T09:09:08Z

Sorry! I totally forgot about this one! I'll try to have another look tomorrow.

RodrigoATorres added 4 commits April 8, 2020 10:16

Added execution arguments for .desktop programs

764c2c4

Adding possibility to add arguments to regular executable files

9eff5df

Added funcionality to guarantee that the windows are open and moved i…

3f764a0

…n the correct order, making sure the windows will be moved to the right place when using custom input arguments

Fixing arguments for executable files

f831f63

RodrigoATorres added 2 commits April 22, 2020 18:51

Merge branch 'feature/exec_args'

ea43efa

Fixing bug when there are no args for executable files

38056e4

RodrigoATorres force-pushed the feature/exec_args branch from 2dbb08b to 38056e4 Compare April 27, 2020 13:04

RodrigoATorres and others added 7 commits April 27, 2020 11:58

Added flag --allowInputArgs to make possible to run lwsm with origini…

ee22ad3

…al code, or with the newly added, that allows adding input parameters to the window applications

Running prettier to index.ts (should have done it before)

30abb05

Added POLL_ALL_MAX_TIMEOUT_ALLOW_ARGS to configs

13b2166

Bug fixed on return promisses from restoreSession

c555b58

Merge branch 'master' into feature/exec_args

89a23c7

Merge remote-tracking branch 'upstream/master'

0fba482

Merging

55e71f8

RodrigoATorres added 3 commits April 28, 2020 11:38

Adjusting startProgram to allow multiple input arguments for executab…

3f56d70

…le files

Merge remote-tracking branch 'upstream/master'

f64de0a

Merging master

d10d030

Merging

d437643

johannesjo reviewed May 15, 2020

View reviewed changes

RodrigoATorres added 5 commits September 7, 2020 10:19

Removed executable arguments when flag is off, replaced var declarati…

79c14e7

…ons to let

Merging master

9280827

Merge branch 'master' into feature/exec_args

2c9b961

Empty executable args paramenters automaticlly added to json when sav…

0bf45c9

…ed session

Updated README to include instructions on how to use --allowInputArgs…

0ab548f

… flag

Repository owner deleted a comment from freetoken-Tg1483 Sep 13, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add input arguments to the applications #66

Add input arguments to the applications #66

RodrigoATorres commented Apr 22, 2020

johannesjo commented Apr 22, 2020 •

edited

Loading

RodrigoATorres commented Apr 22, 2020

RodrigoATorres commented Apr 27, 2020

johannesjo commented Apr 27, 2020

RodrigoATorres commented Apr 27, 2020

johannesjo commented Apr 27, 2020

RodrigoATorres commented Apr 28, 2020

johannesjo commented Apr 28, 2020

RodrigoATorres commented May 13, 2020

johannesjo commented May 14, 2020

johannesjo May 15, 2020

RodrigoATorres Jun 17, 2020

johannesjo May 15, 2020

RodrigoATorres Jun 17, 2020

ChenSun-Phys commented Jun 16, 2020

RodrigoATorres commented Jun 17, 2020

ChenSun-Phys commented Jun 18, 2020

johannesjo commented Jun 18, 2020 •

edited

Loading

RodrigoATorres commented Sep 7, 2020

johannesjo commented Sep 7, 2020

johannesjo commented Sep 13, 2020

johannesjo commented Feb 11, 2021

Add input arguments to the applications #66

Are you sure you want to change the base?

Add input arguments to the applications #66

Conversation

RodrigoATorres commented Apr 22, 2020

johannesjo commented Apr 22, 2020 • edited Loading

RodrigoATorres commented Apr 22, 2020

RodrigoATorres commented Apr 27, 2020

johannesjo commented Apr 27, 2020

RodrigoATorres commented Apr 27, 2020

johannesjo commented Apr 27, 2020

RodrigoATorres commented Apr 28, 2020

johannesjo commented Apr 28, 2020

RodrigoATorres commented May 13, 2020

johannesjo commented May 14, 2020

johannesjo May 15, 2020

Choose a reason for hiding this comment

RodrigoATorres Jun 17, 2020

Choose a reason for hiding this comment

johannesjo May 15, 2020

Choose a reason for hiding this comment

RodrigoATorres Jun 17, 2020

Choose a reason for hiding this comment

ChenSun-Phys commented Jun 16, 2020

RodrigoATorres commented Jun 17, 2020

ChenSun-Phys commented Jun 18, 2020

johannesjo commented Jun 18, 2020 • edited Loading

RodrigoATorres commented Sep 7, 2020

johannesjo commented Sep 7, 2020

johannesjo commented Sep 13, 2020

johannesjo commented Feb 11, 2021

johannesjo commented Apr 22, 2020 •

edited

Loading

johannesjo commented Jun 18, 2020 •

edited

Loading