Update the Application schema #437

ggeorgievx · 2021-08-02T12:28:15Z

Resolves #314

Modified the Application schema instead of introducing a general, host independent, fdc3.general.app.manifest manifest type describing an application, as agreed inside of Introduce a general, host independent, fdc3.general.app.manifest manifest type describing an application #314:
- Removed the manifestType property
- Removed the manifest property
- Introduced a new required type property
- Introduced a new details property
- Introduced a new hostManifests property (a mapping from host string to host specific application manifest object or URI instead of an array)
Added an example Application definition
Added a test environment for the specification and example

Notes:

Valid values for the type property are browser and host - host would allow application providers to serve applications other than browser ones
The details are not marked as required as they are only needed when the application type is browser. Host type applications should use the hostManifests object for all application details.
The hostManifests is a mapping from host string to host specific application manifest object or URI (added URI for better backwards compatibility as some vendors used URI manifests)
A GitHub workflow could be created for the app-directory's test script

thorsent

I added in some suggested changes around typos and phrasing. Otherwise this looks really good.

src/app-directory/specification/appd.yaml

Co-authored-by: Terry Thorsen <terry@chartiq.com>

rikoe

@kriswest @ggeorgievx @mattjamieson is it okay to merge this as in interrim change on the road to 2.0, even though discussions around AppD are still ongoing? I am happy to do so, if you are.

ggeorgievx · 2021-12-21T17:23:15Z

@rikoe Thank you, Riko. I also don't see an issue with having this merged as there aren't other issues/PRs that conflict with it/offer alternatives. The big one (#468) is still under active discussion and if it were to be voted upon and merged would come with drastic changes anyway.

kriswest · 2021-12-21T17:42:55Z

I also don't see an issue with having this merged as there aren't other issues/PRs that conflict with it/offer alternatives. The big one (#468) is still under active discussion and if it were to be voted upon and merged would come with drastic changes anyway.

I concur. I fully expect to have a further debate on #468 early in the new year + about how to improve appD further.

I've just realised I have a few small review comments pending, I'll submit those now as I think they need dealing with before we merge.

kriswest

Several of my comments have already been dealt with however I think we should adjust the examples so that we're not dependent on external applications/domains + a changelog entry is needed.

src/app-directory/specification/appd.yaml

src/app-directory/specification/examples/application/fdc3-tradingview-chart-orig.js

src/app-directory/specification/test/index.js

src/app-directory/specification/appd.yaml

Co-authored-by: Kris West <kris@cosaic.io>

Update CHANGELOG.md

ggeorgievx · 2021-12-21T19:41:07Z

Several of my comments have already been dealt with however I think we should adjust the examples so that we're not dependent on external applications/domains + a changelog entry is needed.

@kriswest Thank you for the feedback, Kris! I just updated the example application to FDC3 Workbench and also noted all changes inside of the changelog. Please let me know if you have any additional comments/feedback.

kriswest · 2021-12-22T18:13:46Z

src/app-directory/specification/examples/application/fdc3-workbench.js

+module.exports = {
+    appId: 'fdc3-workbench',
+    name: 'FDC3 Workbench',
+    type: 'browser',
+    details: {
+        url: 'https://fdc3.finos.org/toolbox/fdc3-workbench/'
+    },
+    hostManifests: {
+        Glue42: {
+            type: 'window',
+            icon: 'https://fdc3.finos.org/docs/assets/fdc3-logo.png',
+            details: {
+                height: 640,
+                width: 560,
+                left: 120,
+                top: 120,
+                mode: 'tab',
+                allowChannels: true,
+                loader: {
+                    enabled: true,
+                    hideOnLoad: true
+                }
+            },
+            customProperties: {
+                folder: 'FDC3 Toolbox'
+            }
+        }
+    }
+};


The example might as well be exhaustive so I've populated the rest of the optional fields. I've also tweaked it to be valid JSON in case someone needs to copy/paste or we want to switch the example to a JSON file in future. Finally, I've added the Finsemble config example.

@ggeorgievx will need you to run this through the test to make sure it still validates.

Suggested change

module.exports = {

appId: 'fdc3-workbench',

name: 'FDC3 Workbench',

type: 'browser',

details: {

url: 'https://fdc3.finos.org/toolbox/fdc3-workbench/'

},

hostManifests: {

Glue42: {

type: 'window',

icon: 'https://fdc3.finos.org/docs/assets/fdc3-logo.png',

details: {

height: 640,

width: 560,

left: 120,

top: 120,

mode: 'tab',

allowChannels: true,

loader: {

enabled: true,

hideOnLoad: true

}

},

customProperties: {

folder: 'FDC3 Toolbox'

}

}

}

};

module.exports = {

"appId": "fdc3-workbench",

"name": "fdc3-workbench",

"title": "FDC3 Workbench",

"description": "Development and test tool for FDC3 desktop agents and apps",

"version": "1.0.0",

"tooltip": "FDC3 Workbench",

"icons": [

{

"url": "http://fdc3.finos.org/toolbox/fdc3-workbench/fdc3-icon-256.png"

}

],

"images": [

{

"url": "https://fdc3.finos.org/docs/assets/fdc3-logo.png",

"tooltip": "FDC3 logo"

}

],

"contactEmail": "fdc3@finos.org",

"supportEmail": "fdc3-maintainers@finos.org",

"publisher": "FDC3",

"intents": [

{

"name": "ViewChart",

"displayName": "View Chart",

"contexts": ["fdc3.instrument"]

}

],

"type": "browser",

"details": {

"url": "https://fdc3.finos.org/toolbox/fdc3-workbench/"

},

"hostManifests": {

"Glue42": {

"type": "window",

"icon": "https://fdc3.finos.org/docs/assets/fdc3-logo.png",

"details": {

"height": 640,

"width": 560,

"left": 120,

"top": 120,

"mode": "tab",

"allowChannels": true,

"loader": {

"enabled": true,

"hideOnLoad": true

}

},

"customProperties": {

"folder": "FDC3 Toolbox"

}

},

"Finsemble": {

"window": {

"left": 120,

"top": 120,

"width": 800,

"height": 750,

"options": {

"minWidth": 75

}

},

"foreign": {

"components": {

"App Launcher": {

"launchableByUser": true

},

"Toolbar": {

"iconURL": "http://fdc3.finos.org/toolbox/fdc3-workbench/fdc3-icon-256.png"

},

"Window Manager": {

"FSBLHeader": true,

"persistWindowState": true

}

}

},

"interop": {

"autoConnect": true

}

}

}

};

kriswest

Although I think there will definitely be further changes, I think this PR can be merged as its an improvement on the current state.

@ggeorgievx I've suggested a change to the example that I'd appreciate you integrating (and giving a quick test) before we merge.

ggeorgievx · 2022-01-06T11:34:49Z

Although I think there will definitely be further changes, I think this PR can be merged as its an improvement on the current state.

@ggeorgievx I've suggested a change to the example that I'd appreciate you integrating (and giving a quick test) before we merge.

@kriswest Thank you, Kris! I updated the example and ran the test successfully. We should be ready to go on this one.

kriswest

LGTM

ggeorgievx added enhancement New feature or request app-directory labels Aug 2, 2021

ggeorgievx added this to the 2.0 milestone Aug 2, 2021

ggeorgievx requested review from mattjamieson, kriswest, rikoe and lspiro-Tick42 August 2, 2021 12:28

finos-cla-bot bot added the cla-present label Aug 2, 2021

Update the Application schema

4ae6e31

ggeorgievx force-pushed the feat/update-application-schema branch from e0440f9 to 4ae6e31 Compare August 2, 2021 12:40

thorsent reviewed Aug 31, 2021

View reviewed changes

kriswest mentioned this pull request Sep 7, 2021

Channels, Feeds & Transactions Discussion group meeting 9th Sept 2021 #452

Closed

21 tasks

kriswest mentioned this pull request Sep 21, 2021

Standard WG Meeting - Sept 23, 2021 #459

Closed

14 tasks

ggeorgievx and others added 5 commits September 23, 2021 16:20

Update src/app-directory/specification/appd.yaml

18d8995

Co-authored-by: Terry Thorsen <terry@chartiq.com>

Update src/app-directory/specification/appd.yaml

4a8998d

Co-authored-by: Terry Thorsen <terry@chartiq.com>

Update src/app-directory/specification/appd.yaml

364312d

Co-authored-by: Terry Thorsen <terry@chartiq.com>

Update src/app-directory/specification/appd.yaml

6b2de7d

Co-authored-by: Terry Thorsen <terry@chartiq.com>

Update src/app-directory/specification/appd.yaml

94eb302

Co-authored-by: Terry Thorsen <terry@chartiq.com>

mattjamieson approved these changes Oct 6, 2021

View reviewed changes

kriswest mentioned this pull request Oct 22, 2021

Standard WG Meeting - Oct 28th, 2021 #481

Closed

11 tasks

kriswest mentioned this pull request Nov 15, 2021

Standard WG Meeting - Nov 18th, 2021 #505

Closed

10 tasks

rikoe approved these changes Dec 21, 2021

View reviewed changes

kriswest requested changes Dec 21, 2021

View reviewed changes

kriswest reviewed Dec 21, 2021

View reviewed changes

src/app-directory/specification/appd.yaml Outdated Show resolved Hide resolved

ggeorgievx and others added 2 commits December 21, 2021 21:10

Update src/app-directory/specification/appd.yaml

57116fd

Co-authored-by: Kris West <kris@cosaic.io>

Change the example application to FDC3 Workbench

ef36e14

Update CHANGELOG.md

ggeorgievx requested a review from kriswest December 21, 2021 19:36

kriswest reviewed Dec 22, 2021

View reviewed changes

kriswest approved these changes Dec 22, 2021

View reviewed changes

Update the example application

451b7c5

kriswest approved these changes Jan 6, 2022

View reviewed changes

kriswest merged commit cbf7a55 into master Jan 18, 2022

ggeorgievx mentioned this pull request Jan 18, 2022

Add backwards compatibility support for the App Directory #553

Closed

This was referenced Jan 24, 2022

Better describe relationship between AppD definitions and other manifests #556

Closed

Add vendor-agnostic properties to the AppD application definition format for launching native apps #562

Closed

Standard WG Meeting - January 27, 2022 #568

Closed

kriswest mentioned this pull request Feb 4, 2022

App Directory Discussion group - Feb 08, 2022 #573

Closed

4 tasks

kriswest mentioned this pull request Mar 16, 2022

App Directory Discussion group - Monday 21st March 2022 #626

Closed

13 tasks

rikoe deleted the feat/update-application-schema branch March 31, 2022 09:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update the Application schema #437

Update the Application schema #437

ggeorgievx commented Aug 2, 2021 •

edited

Loading

thorsent left a comment

rikoe left a comment

ggeorgievx commented Dec 21, 2021 •

edited

Loading

kriswest commented Dec 21, 2021

kriswest left a comment

ggeorgievx commented Dec 21, 2021

kriswest Dec 22, 2021

kriswest left a comment

ggeorgievx commented Jan 6, 2022

kriswest left a comment

Update the Application schema #437

Update the Application schema #437

Conversation

ggeorgievx commented Aug 2, 2021 • edited Loading

thorsent left a comment

Choose a reason for hiding this comment

rikoe left a comment

Choose a reason for hiding this comment

ggeorgievx commented Dec 21, 2021 • edited Loading

kriswest commented Dec 21, 2021

kriswest left a comment

Choose a reason for hiding this comment

ggeorgievx commented Dec 21, 2021

kriswest Dec 22, 2021

Choose a reason for hiding this comment

kriswest left a comment

Choose a reason for hiding this comment

ggeorgievx commented Jan 6, 2022

kriswest left a comment

Choose a reason for hiding this comment

ggeorgievx commented Aug 2, 2021 •

edited

Loading

ggeorgievx commented Dec 21, 2021 •

edited

Loading