feat: Allow async endpoint options #139
Conversation
| @@ -54,6 +54,7 @@ export default class Client { | |||
| previewsUrl: "https://previews.goabstract.com", | |||
| transportMode: "api", | |||
| webUrl: "https://app.goabstract.com", | |||
| // $FlowFixMe https://github.com/facebook/flow/pull/7298 | |||
| ...options | |||
| }; | |||
There was a problem hiding this comment.
re: facebook/flow#7298 (comment)
From Jordan Brown @ Facebook
That's a separate issue, your spread issue will be solved by my value spreads work. I'm hoping that the type spread portion will land soon and then I'll be full steam ahead on value spreads. It's definitely super annoying. If you have suppression comments configured, this is the perfect time to use one!
I upgraded flow so that I could easily $FlowFixMe this. Prior to 0.101 the error showed up 4 times, requiring suppression comments on [1][3][5] and [7]
Cannot spread options because:
• Promise [1] is incompatible with string [2].
• Promise [3] is incompatible with string [4].
• Promise [5] is incompatible with string [6].
• Promise [7] is incompatible with string [8].
src/Client.js
[2] 50│ apiUrl: "https://api.goabstract.com",
51│ cliPath:
[4] 52│ "/Applications/Abstract.app/Contents/Resources/app.asar.unpacked/node_modules/@elasticprojects/abstract-cli/bin/abstract-cli",
53│ maxCacheSize: 0,
[6] 54│ previewsUrl: "https://previews.goabstract.com",
55│ transportMode: "api",
[8] 56│ webUrl: "https://app.goabstract.com",
57│ // $FlofwFixMe https://github.com/facebook/flow/pull/7298
58│ ...options
59│ };
60│
61│ this.activities = new Activities(this, options);
src/types.js
[1] 1467│ apiUrl: string | Promise<string>,
[3] 1468│ cliPath: string | Promise<string>,
1469│ maxCacheSize: number,
[5] 1470│ previewsUrl: string | Promise<string>,
1471│ transportMode: "auto" | "api" | "cli",
[7] 1472│ webUrl: string | Promise<string>
| const callArgs = (child_process.spawn: any).mock.calls[0][1].slice( | ||
| -args.length | ||
| ); | ||
|
|
There was a problem hiding this comment.
child_process is now covered and spawn.mock does not exist
| @@ -205,7 +206,7 @@ export default class Endpoint { | |||
| return response; | |||
| } | |||
|
|
|||
| async _getAPIHeaders(headers?: Object) { | |||
| async _getAPIHeaders(headers?: {}) { | |||
There was a problem hiding this comment.
Object === any. Switching to {} where possible is a quick way to expand coverage
There was a problem hiding this comment.
Object === any – wait, what? 😢
There was a problem hiding this comment.
@tommoor yea... same as Function https://flow.org/en/docs/types/objects/#toc-object-type
| ) { | ||
| const hostname = | ||
| overrideHostname !== undefined ? overrideHostname : await this.apiUrl; |
| ) { | ||
| const hostname = | ||
| overrideHostname !== undefined ? overrideHostname : await this.apiUrl; |
| this.cliPath, | ||
| [...tokenArgs, "--api-url", this.apiUrl, ...args] | ||
| cliPath, | ||
| [...tokenArgs, "--api-url", await this.apiUrl, ...args] |
| @@ -33,7 +37,7 @@ export default class Previews extends Endpoint { | |||
| "Abstract-Api-Version": undefined | |||
| } | |||
| }, | |||
| this.previewsUrl | |||
| await this.previewsUrl | |||
amccloud
changed the title
|
@amccloud: Let me know when this is out of draft and ready to review - excited to land this. |
|
@bitpshr thanks! It’s pretty much ready but having some ci woes. Not sure if it’s because I recently changed node versions but the integrity hashes are off 🤔 Edit: All set. I had to clear my local |
To support desktop's async config https://github.com/goabstract/ui/pull/1215 we need to allow for
previewsUrlto be asyncI went ahead and updated
previewsUrland the remaining configs that may be used asynchronously one day. Was straight forward because everywhere these options are used were already async 👍previewsUrl,apiUrl, 'webUrl', andcliPathtostring | Promise<string>