-
Notifications
You must be signed in to change notification settings - Fork 3
Toolbar 1.0 #2
base: master
Are you sure you want to change the base?
Toolbar 1.0 #2
Conversation
Can we please keep making changes to the same PR instead of creating a new one? You can do this by continuing committing changes to the same branch as for the original PR. Otherwise we split comments over multiple PRs and we are not sure whether comments on one PR was addressed by commits to another. I am not sure whether to review this one or the previous one now, but I am going to pick this one since it is newer. |
Hi Riko,
All further changes will be made in the branch for the second PR from now on.
Thank you for your email!
Kind Regards,
INA KOSTOVA | Developer
[Description: tick42_footer]
E: [email protected]<mailto:[email protected]>
W: http://www.tick42.com<http://www.tick42.com/>
From: Riko Eksteen <[email protected]>
Sent: 30 May 2019 10:39
To: FDC3/appd-launcher-poc <[email protected]>
Cc: Ina Kostova <[email protected]>; Author <[email protected]>
Subject: Re: [FDC3/appd-launcher-poc] Toolbar 1.0 (#2)
Can we please keep making changes to the same PR instead of creating a new one? You can do this by continuing committing changes to the same branch as for the original PR.
Otherwise we split comments over multiple PRs and we are not sure whether comments on one PR was addressed by commits to another.
I am not sure whether to review this one or the previous one now, but I am going to pick this one since it is newer.
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub<#2?email_source=notifications&email_token=AFKDKJYARWLHYHSHNQ3KDXDPX6ABRA5CNFSM4HN5IW5KYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODWRTYPY#issuecomment-497237055>, or mute the thread<https://github.com/notifications/unsubscribe-auth/AFKDKJ46I3ONB6SIHGJUPODPX6ABRANCNFSM4HN5IW5A>.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for this contribution! Looks good. Nothing major needs to be changed, but the context data interface being used is currently not FDC3 1.0 compliant, and that needs to be fixed before this can be accepted as part of FDC3's projects.
|
||
### Prerequisites | ||
|
||
You will need node.js & npm as well as a globally installed electron (npm i -g electron). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please specify the minium version of node and npm required, if any.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Node.js and npm minimum versions are added
- run build-ui.bat | ||
- run build-app.bat | ||
- run start.bat | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am highly opposed to including Windows batch files in the source code, as it is not platform-agnostic. Node, npm and Electron are all platform-agnostic and if they are the only prerequisites (as stated above), then the build and run scripts should be too.
Node and npm makes this straightforward by including task scripts in package.json that can then be run with npm start
and npm run build
etc.
Can you please try to replicate the contents of the batch files as package.json scripts, I am happy to help if needed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We tested the building and starting of the project on Windows. We will test on MacOS and we’ll add instructions and update the build process.
README.md
Outdated
|
||
#### <a name="appd-poc-provider"></a> AppD PoC provider | ||
|
||
In order to use the Glue42 FINOS FDC3 App Directroy toolbar, you need to have AppD services to connect to. If you do not have access to services, you can run your own instances using the [appd-poc](https://github.com/FDC3/appd-poc), a Java server. Steps to run: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"App Directory" not "App Directroy"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If this project is to be hosted inside the FDC3 organisation on GitHub l, it cannot be branded as "Glue42 FINOS FDC3 App Directory Toolbar".
Please call it "FDC3 Demo Toolbar" or something similar. If you would like to keep the branding you are welcome to host it on your own organisation's GitHub - we don't use organisational branding for projects in FDC3.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Title is updated, typo is fixed.
- Launch the appd-poc | ||
|
||
- Register a user with the appd-poc | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are there instructions for the above steps?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The README.md contains a link to the AppD Services with instructions.
README.md
Outdated
|
||
##### [org.finos.fdc3.demo](./app/apps/schemas/org.finos.fdc3.demo-manifest-schema.json) | ||
|
||
Support for starting application of manifestType `org.finos.fdc3.demo.host` is scheduled for version 1.1. This manifestType is used for applications that are started via the FDC3 API. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this true? If so I am not aware of it. Can someone from AppD WG confirm this?
We should be careful of including statements about future versions of FDC3 that may change before release.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The statement is updated.
Support for starting application of manifestType
org.finos.fdc3.demo.host
is scheduled for version 1.1 of the Toolbar. This can be viewed in the FINOS Plexus Interop API examples. This manifestType is used for applications that are started via the FDC3 API.
<html lang="en"> | ||
<head> | ||
<meta charset="utf-8"> | ||
<title>Glue42 FINOS FDC3 AppD demo application config</title> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Glue42 reference in vendor-agnostic FDC3 repo.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Glue42 reference is removed.
<title>FDC3 Demo Toolbar application config</title>
<html lang="en"> | ||
<head> | ||
<meta charset="utf-8"> | ||
<title>Glue42 FINOS FDC3 AppD demo logs</title> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Glue42 reference
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Glue42 reference is removed.
<title>FDC3 Demo Toolbar demo logs</title>
<html lang="en"> | ||
<head> | ||
<meta charset="utf-8"> | ||
<title>Glue42 FINOS FDC3 AppD demo provider config</title> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Glue42 reference.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Glue42 reference is removed.
<title>FDC3 Demo Toolbar provider config</title>
toolbar-ui-angular/src/index.html
Outdated
<html lang="en"> | ||
<head> | ||
<meta charset="utf-8"> | ||
<title>Glue42 FINOS FDC3 AppD demo toolbar</title> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Glue42 reference.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Glue42 reference is removed.
<title>FDC3 Demo Toolbar</title>
The UI is oriented towards developers who are investigating the AppD service, for example it provides easy access to view the JSon definitions of the applications and to easily view the log files. However the UI is functional and a production oriented toolbar could easily be created by removing access to some features. | ||
|
||
The UI shows the integration of the FDC3 AppD Services API and the FDC3 API used to launch applications. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems a lot of the information above is relevant to the repository as a whole and not just limited to "toolbar-ui-angular" and its README.
I am slightly confused what the relationship is between the "app" component and the "toolbar-ui-angular" component and how they work together.
I think this should be clarified in the root README for this project:
- Overall context
- What components are included
- How do they relate to each other
- How do you run all the components + any dependencies and make them work together
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
README.md is updated.
App Directory Demo Launcher aka Toolbar
This Toolbar, contributed by Tick42, connects to one or more FINOS FDC3 compatible application directories that implement the FDC3 App Directory REST API https://fdc3.finos.org/appd-spec. The Toolbar will show all the defined applications, and will attempt to launch applications that are defined by a supported Manifest type.
The Toolbar can also show a set of favourite applications as Icons in the main Toolbar.
The Toolbar is primarily aimed at developers working with FINOS FDC3, it provides easy access to the application definitions and to the log files to allow developers to explore the services.
Toolbar components
The Toolbar is separated into two main components
app
The app component is a standalone Electron application. It also includes wrappers for the App Directory services.
It loads the Toolbar window with a URI that is stored in ./toolbar-ui-angular/dist
.
toolbar-ui-angular
The toolbar-ui-angular component is the Toolbar window displayed by the Electron application. It is written with Angular 7.
By default the Electron application starts the Toolbar window in file mode.
The Toolbar is currently aware of the following manifest types:
- 'org.finos.fdc3.demo' - covers browser/exe and therefore is platform/host independent
- 'org.finos.fdc3.demo.host' - covers platform/host specific applications
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I still cannot build the ui app:
npm ERR! code E404
npm ERR! 404 Not Found - GET https://registry.npmjs.org/glue-interop-api-impl - Not found
npm ERR! 404
npm ERR! 404 '[email protected]' is not in the npm registry.
npm ERR! 404 You should bug the author to publish it (or use the name yourself!)
npm ERR! 404 It was specified as a dependency of 'toolbar-ui-angular'
npm ERR! 404
npm ERR! 404 Note that you can also install from a
npm ERR! 404 tarball, folder, http url, or git url.
npm ERR! A complete log of this run can be found in:
npm ERR! /Users/riko/.npm/_logs/2019-06-14T13_07_43_102Z-debug.log
Hi Riko,
This was fixed in PR #2 – the package has been removed.
Kind Regards,
INA KOSTOVA | Developer
[Description: tick42_footer]
E: [email protected]<mailto:[email protected]>
W: http://www.tick42.com<http://www.tick42.com/>
From: Riko Eksteen <[email protected]>
Sent: 14 June 2019 16:19
To: FDC3/appd-launcher-poc <[email protected]>
Cc: Ina Kostova <[email protected]>; Author <[email protected]>
Subject: Re: [FDC3/appd-launcher-poc] Toolbar 1.0 (#2)
@rikoe requested changes on this pull request.
I still cannot build the ui app:
npm ERR! code E404
npm ERR! 404 Not Found - GET https://registry.npmjs.org/glue-interop-api-impl - Not found
npm ERR! 404
npm ERR! 404 '[email protected]' is not in the npm registry.
npm ERR! 404 You should bug the author to publish it (or use the name yourself!)
npm ERR! 404 It was specified as a dependency of 'toolbar-ui-angular'
npm ERR! 404
npm ERR! 404 Note that you can also install from a
npm ERR! 404 tarball, folder, http url, or git url.
npm ERR! A complete log of this run can be found in:
npm ERR! /Users/riko/.npm/_logs/2019-06-14T13_07_43_102Z-debug.log
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub<#2?email_source=notifications&email_token=AFKDKJ3727KFL2CJNRD2LZ3P2OLDHA5CNFSM4HN5IW5KYY3PNVWWK3TUL52HS4DFWFIHK3DMKJSXC5LFON2FEZLWNFSXPKTDN5WW2ZLOORPWSZGOB3SSARI#pullrequestreview-249897029>, or mute the thread<https://github.com/notifications/unsubscribe-auth/AFKDKJ6TUEFPT5MVII44JOLP2OLDHANCNFSM4HN5IW5A>.
|
Apologies @ikostova-Tick42 , I was building on the wrong branch. |
Hi @ikostova-Tick42 - I haven't had a chance to look at this again recently, I will try to take a look soon! One question - should we rename the PR to say something different than "Toolbar 1.0" until we can work through remaining issues, if any? A 0.7 or 0.9 feels more appropriate at this stage, but tbh we don't necessarily have to "version" the code right now. |
I was able to build, validate and run the
To run it, simply execute
Hope this helps. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ikostova-Tick42 @maoo I am still having lots of issues with the build. I have made sure I am on the right branch this time (doh!) and to follow your instructions closely @maoo.
I am building on Mac - the issues I am having are around installing npm packages and building toolbar-ui-angular
, specifically node-sass. It may be that the issues are due to my environment/setup.
I don't want to hold you up any further though (sorry!), so let's merge the PR, and address any further problems in the usual GitHub way - creating an issue and submitting individual PRs to fix them.
@ikostova-Tick42 @lspiro-Tick42 See comment I just added to the issue created to track to the migration of FDC3 repos into the /finos github org. |
"glue-interop-api-impl" and "glue-fdc3-access-impl" dependencies are removed
fix for window collapse/expand related to the latest electron