Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
C
coopwire-hypothesis
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
孙灵跃 Leon Sun
coopwire-hypothesis
Commits
1997770f
Commit
1997770f
authored
Apr 20, 2023
by
Alejandro Celaya
Committed by
Alejandro Celaya
Apr 20, 2023
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Migrate build-settings module to TS
parent
6ed0156a
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
47 additions
and
59 deletions
+47
-59
build-settings.ts
src/sidebar/config/build-settings.ts
+45
-58
postmessage-json-rpc.js
src/sidebar/util/postmessage-json-rpc.js
+2
-1
No files found.
src/sidebar/config/build-settings.
j
s
→
src/sidebar/config/build-settings.
t
s
View file @
1997770f
import
type
{
ConfigFromHost
,
ConfigFromAnnotator
,
ConfigFromEmbedder
,
ConfigFromSidebar
,
RPCSettings
,
SidebarSettings
,
}
from
'../../types/config'
;
import
*
as
postMessageJsonRpc
from
'../util/postmessage-json-rpc'
;
import
{
getApiUrl
}
from
'./get-api-url'
;
import
{
hostPageConfig
}
from
'./host-config'
;
/**
* @typedef {import('../../types/config').ConfigFromHost} ConfigFromHost
* @typedef {import('../../types/config').ConfigFromAnnotator} ConfigFromAnnotator
* @typedef {import('../../types/config').ConfigFromEmbedder} ConfigFromEmbedder
* @typedef {import('../../types/config').ConfigFromSidebar} ConfigFromSidebar
* @typedef {import('../../types/config').RPCSettings} RPCSettings
* @typedef {import('../../types/config').SidebarSettings} SidebarSettings
* @typedef {import('../../types/config').Service['groups']} ServiceGroups
*/
/**
* Ascend `levels` from `window_` to find the designated embedder frame.
*
* @param {number} levels - Number of ancestors levels to ascend
* @param {Window=} window_
* @return {Window}
* @param levels - Number of ancestors levels to ascend
*/
function
getEmbedderFrame
(
levels
,
window_
=
window
)
{
function
getEmbedderFrame
(
levels
:
number
,
window_
:
Window
=
window
):
Window
{
let
ancestorWindow
=
window_
;
for
(
let
i
=
0
;
i
<
levels
;
i
++
)
{
if
(
ancestorWindow
===
ancestorWindow
.
top
)
{
...
...
@@ -40,14 +36,11 @@ function getEmbedderFrame(levels, window_ = window) {
* This function (maybe) mutates values in the provided `configFromHost`'s
* ServiceGroups: `$rpc:requestGroups` values are replaced with
* `Promise<string[]>`.
*
* @see ServiceGroups
*
* @param {ConfigFromHost} configFromHost
* @param {RPCSettings} rpcSettings
* @return {ConfigFromHost}
*/
function
fetchServiceGroups
(
configFromHost
,
rpcSettings
)
{
function
fetchServiceGroups
(
configFromHost
:
ConfigFromHost
,
rpcSettings
:
RPCSettings
):
ConfigFromHost
{
const
services
=
configFromHost
.
services
;
if
(
!
Array
.
isArray
(
services
))
{
return
configFromHost
;
...
...
@@ -56,9 +49,8 @@ function fetchServiceGroups(configFromHost, rpcSettings) {
if
(
service
.
groups
===
'$rpc:requestGroups'
)
{
// The `groups` need to be fetched from a secondary RPC call and
// there should be no timeout as it may be waiting for user input.
service
.
groups
=
/** @type {Promise<string[]>} */
(
postMessageJsonRpc
.
call
(
service
.
groups
=
postMessageJsonRpc
.
call
<
string
[]
>
(
rpcSettings
.
targetFrame
,
rpcSettings
.
origin
,
'requestGroups'
,
...
...
@@ -67,8 +59,7 @@ function fetchServiceGroups(configFromHost, rpcSettings) {
)
.
catch
(()
=>
{
throw
new
Error
(
'Unable to fetch groups'
);
})
);
});
}
});
return
configFromHost
;
...
...
@@ -76,12 +67,11 @@ function fetchServiceGroups(configFromHost, rpcSettings) {
/**
* Derive RPC settings from the provided `ConfigFromAnnotator`, if any are present.
*
* @param {ConfigFromAnnotator} configFromAnnotator
* @param {Window} window_
* @return {import('../../types/config').RPCSettings|null}
*/
function
buildRPCSettings
(
configFromAnnotator
,
window_
)
{
function
buildRPCSettings
(
configFromAnnotator
:
ConfigFromAnnotator
,
window_
:
Window
):
RPCSettings
|
null
{
const
rpcConfig
=
configFromAnnotator
.
requestConfigFromFrame
;
if
(
!
rpcConfig
)
{
return
null
;
...
...
@@ -101,20 +91,17 @@ function buildRPCSettings(configFromAnnotator, window_) {
/**
* Retrieve host configuration from embedder frame
*
* @param {ConfigFromAnnotator} configFromAnnotator
* @param {RPCSettings} rpcSettings
* @return {Promise<ConfigFromEmbedder>}
*/
async
function
getEmbedderConfig
(
configFromAnnotator
,
rpcSettings
)
{
const
configFromEmbedder
=
/** @type {ConfigFromEmbedder} */
(
await
postMessageJsonRpc
.
call
(
async
function
getEmbedderConfig
(
configFromAnnotator
:
ConfigFromAnnotator
,
rpcSettings
:
RPCSettings
):
Promise
<
ConfigFromEmbedder
>
{
const
configFromEmbedder
=
await
postMessageJsonRpc
.
call
<
ConfigFromEmbedder
>
(
rpcSettings
.
targetFrame
,
rpcSettings
.
origin
,
'requestConfig'
,
[],
3000
)
);
// In cases where host configuration is requested from the embedder frame
...
...
@@ -138,11 +125,12 @@ async function getEmbedderConfig(configFromAnnotator, rpcSettings) {
* @see {ConfigFromEmbedder}
* @see {ConfigFromHost}
*
* @param {ConfigFromSidebar} configFromSidebar
* @param {Window} window_ - Test seam
* @return {Promise<SidebarSettings>} - The merged settings
* @return The merged settings
*/
export
async
function
buildSettings
(
configFromSidebar
,
window_
=
window
)
{
export
async
function
buildSettings
(
configFromSidebar
:
ConfigFromSidebar
,
window_
:
Window
=
window
):
Promise
<
SidebarSettings
>
{
const
configFromAnnotator
=
hostPageConfig
(
window
);
const
rpcSettings
=
buildRPCSettings
(
configFromAnnotator
,
window_
);
...
...
@@ -160,8 +148,7 @@ export async function buildSettings(configFromSidebar, window_ = window) {
configFromHost
=
configFromAnnotator
;
}
/** @type {SidebarSettings} */
const
sidebarSettings
=
{
const
sidebarSettings
:
SidebarSettings
=
{
...
configFromSidebar
,
...
configFromHost
,
};
...
...
src/sidebar/util/postmessage-json-rpc.js
View file @
1997770f
...
...
@@ -15,13 +15,14 @@ function createTimeout(delay, message) {
/**
* Make a JSON-RPC call to a server in another frame using `postMessage`.
*
* @template T
* @param {Window} frame - Frame to send call to
* @param {string} origin - Origin filter for `window.postMessage` call
* @param {string} method - Name of the JSON-RPC method
* @param {unknown[]} params - Parameters of the JSON-RPC method
* @param {number} [timeout] - Maximum time to wait in ms
* @param {Window} [window_] - Test seam.
* @return {Promise<
unknown
>} - A Promise for the response to the call
* @return {Promise<
T
>} - A Promise for the response to the call
*/
export
function
call
(
frame
,
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment