Compare commits

...

4 Commits

Author SHA1 Message Date
310dac296f feat(storage,sqlite): begin tx with context
All checks were successful
arcad/edge/pipeline/head This commit looks good
2023-04-13 11:23:34 +02:00
4db7576b12 feat(client,sdk): retrieve auth token from parent frame + better resize detection
All checks were successful
arcad/edge/pipeline/head This commit looks good
2023-04-13 11:02:24 +02:00
f5283b86ed fix(app,manifest): manifest serialization
All checks were successful
arcad/edge/pipeline/head This commit looks good
2023-04-11 15:08:07 +02:00
98ebd7a168 doc(app,manifest): add metadata attribute in manifest schema
All checks were successful
arcad/edge/pipeline/head This commit looks good
2023-04-11 11:11:00 +02:00
14 changed files with 312 additions and 116 deletions

View File

@ -49,10 +49,11 @@ URL associée à l'application, ou `null` si aucune application n'a été trouv
```typescript
interface Manifest {
id: string // Identifiant de l'application
version: string // Version de l'application
title: string // Titre associé à l'application
description: string // Description associée à l'application
tags: string[] // Mots clés associés à l'application
id: string // Identifiant de l'application
version: string // Version de l'application
title: string // Titre associé à l'application
description: string // Description associée à l'application
tags: string[] // Mots clés associés à l'application
metadata: { [key: string]: any } // Métadonnées associées à l'application. Voir ../manifest.md
}
```

View File

@ -4,4 +4,9 @@ title: SDK Test
version: 0.0.0
description: |
Suite de tests pour le SDK client
tags: ["test"]
tags: ["test"]
metadata:
paths:
icon: /icon.png
minimumRole: visitor

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB

View File

@ -4,6 +4,7 @@
<meta charset="utf-8" />
<title>Client SDK Test suite</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="icon" type="image/png" href="/icon.png">
<link rel="stylesheet" href="/vendor/mocha.css" />
<style>
body {

View File

@ -38,7 +38,7 @@ describe('Remote Procedure Call', function () {
it('should call the add() method repetitively and keep count of the sent values', function () {
this.timeout(10000);
this.timeout(30000);
const values = [];
for (let i = 0; i <= 1000; i++) {

View File

@ -12,12 +12,12 @@ import (
type ID string
type Manifest struct {
ID ID `yaml:"id" json:"id"`
Version string `yaml:"version" json:"version"`
Title string `yaml:"title" json:"title"`
Description string `yaml:"description" json:"description"`
Tags []string `yaml:"tags" json:"tags"`
Metadata map[string]any `yaml:"metadata" json:"metadata"`
ID ID `yaml:"id" json:"id"`
Version string `yaml:"version" json:"version"`
Title string `yaml:"title" json:"title"`
Description string `yaml:"description" json:"description"`
Tags []string `yaml:"tags" json:"tags"`
Metadata MapStr `yaml:"metadata" json:"metadata"`
}
type MetadataValidator func(map[string]any) (bool, error)

61
pkg/app/map_str.go Normal file
View File

@ -0,0 +1,61 @@
package app
import (
"fmt"
"github.com/pkg/errors"
)
type MapStr map[string]interface{}
func MapStrUnion(dict1 MapStr, dict2 MapStr) MapStr {
dict := MapStr{}
for k, v := range dict1 {
dict[k] = v
}
for k, v := range dict2 {
dict[k] = v
}
return dict
}
func (ms *MapStr) UnmarshalYAML(unmarshal func(interface{}) error) error {
var result map[interface{}]interface{}
err := unmarshal(&result)
if err != nil {
return errors.WithStack(err)
}
*ms = cleanUpInterfaceMap(result)
return nil
}
func cleanUpInterfaceArray(in []interface{}) []interface{} {
result := make([]interface{}, len(in))
for i, v := range in {
result[i] = cleanUpMapValue(v)
}
return result
}
func cleanUpInterfaceMap(in map[interface{}]interface{}) MapStr {
result := make(MapStr)
for k, v := range in {
result[fmt.Sprintf("%v", k)] = cleanUpMapValue(v)
}
return result
}
func cleanUpMapValue(v interface{}) interface{} {
switch v := v.(type) {
case []interface{}:
return cleanUpInterfaceArray(v)
case map[interface{}]interface{}:
return cleanUpInterfaceMap(v)
case string:
return v
default:
return fmt.Sprintf("%v", v)
}
}

View File

@ -26,28 +26,23 @@ func WithNamedPathsValidator(names ...NamedPath) app.MetadataValidator {
return true, nil
}
paths, ok := rawPaths.(map[any]any)
paths, ok := rawPaths.(app.MapStr)
if !ok {
return false, errors.Errorf("metadata['paths']: unexpected named path value type '%T'", rawPaths)
}
for n, p := range paths {
name, ok := n.(string)
if !ok {
return false, errors.Errorf("metadata['paths']: unexpected named path type '%T'", n)
}
if _, exists := set[NamedPath(name)]; !exists {
return false, errors.Errorf("metadata['paths']: unexpected named path '%s'", name)
if _, exists := set[NamedPath(n)]; !exists {
return false, errors.Errorf("metadata['paths']: unexpected named path '%s'", n)
}
path, ok := p.(string)
if !ok {
return false, errors.Errorf("metadata['paths']['%s']: unexpected named path value type '%T'", name, path)
return false, errors.Errorf("metadata['paths']['%s']: unexpected named path value type '%T'", n, path)
}
if !strings.HasPrefix(path, "/") {
return false, errors.Errorf("metadata['paths']['%s']: named path value should start with a '/'", name)
return false, errors.Errorf("metadata['paths']['%s']: named path value should start with a '/'", n)
}
}

View File

@ -14,11 +14,12 @@ type Module struct {
}
type gojaManifest struct {
ID string `goja:"id" json:"id"`
Version string `goja:"version" json:"version"`
Title string `goja:"title" json:"title"`
Description string `goja:"description" json:"description"`
Tags []string `goja:"tags" json:"tags"`
ID string `goja:"id" json:"id"`
Version string `goja:"version" json:"version"`
Title string `goja:"title" json:"title"`
Description string `goja:"description" json:"description"`
Tags []string `goja:"tags" json:"tags"`
Metadata map[string]any `goja:"metadata" json:"metadata"`
}
func toGojaManifest(manifest *app.Manifest) *gojaManifest {
@ -28,6 +29,7 @@ func toGojaManifest(manifest *app.Manifest) *gojaManifest {
Title: manifest.Title,
Description: manifest.Description,
Tags: manifest.Tags,
Metadata: manifest.Metadata,
}
}

View File

@ -3865,6 +3865,8 @@ var Edge = (() => {
var import_sockjs_client = __toESM(require_entry());
var EventTypeMessage = "message";
var EdgeAuth = "edge-auth";
var EdgeAuthTokenRequest = "edge_auth_token_request";
var EdgeAuthTokenResponse = "edge_auth_token_reponse";
var Client = class extends EventTarget {
constructor(autoReconnect = true) {
super();
@ -3872,6 +3874,7 @@ var Edge = (() => {
this._onConnectionClose = this._onConnectionClose.bind(this);
this._onConnectionMessage = this._onConnectionMessage.bind(this);
this._handleRPCResponse = this._handleRPCResponse.bind(this);
this._handleEdgeAuthTokenRequest = this._handleEdgeAuthTokenRequest.bind(this);
this._rpcID = 0;
this._pendingRPC = {};
this._queue = [];
@ -3884,12 +3887,22 @@ var Edge = (() => {
this.send = this.send.bind(this);
this.upload = this.upload.bind(this);
this.addEventListener(EventTypeMessage, this._handleRPCResponse);
window.addEventListener("message", this._handleEdgeAuthTokenRequest);
}
connect(token = "") {
let getToken;
if (token) {
getToken = Promise.resolve(token);
} else {
getToken = this._retrieveToken();
}
return getToken.then((token2) => this._connect(token2));
}
disconnect() {
this._cleanupConnection();
}
_connect(token) {
return new Promise((resolve, reject) => {
if (token == "") {
token = this._getAuthCookieToken();
}
const url = `//${document.location.host}/edge/sock?${EdgeAuth}=${token}`;
this._log("opening connection to", url);
const conn = new import_sockjs_client.default(url);
@ -3920,15 +3933,64 @@ var Edge = (() => {
conn.addEventListener("close", onError);
});
}
disconnect() {
this._cleanupConnection();
_retrieveToken() {
let token = this._getAuthCookieToken();
if (token) {
return Promise.resolve(token);
}
return this._getParentFrameToken();
;
}
_getAuthCookieToken() {
const cookie = document.cookie.split("; ").find((row) => row.startsWith(EdgeAuth));
let token = "";
if (cookie) {
return cookie.split("=")[1];
token = cookie.split("=")[1];
}
return "";
return token;
}
_getParentFrameToken(timeout = 5e3) {
if (!window.parent || window.parent === window) {
return Promise.resolve("");
}
return new Promise((resolve, reject) => {
let timedOut = false;
const timeoutId = setTimeout(() => {
timedOut = true;
reject(new Error("Edge auth token request timed out !"));
}, timeout);
const listener = (evt) => {
const message = evt.data;
if (!message || !message.type || !message.data) {
return;
}
if (message.type !== EdgeAuthTokenResponse) {
return;
}
window.parent.removeEventListener("message", listener);
clearTimeout(timeoutId);
if (timedOut)
return;
if (!message.data || !message.data.token) {
reject("Unexpected auth token request response !");
return;
}
resolve(message.data.token);
};
window.parent.addEventListener("message", listener);
window.parent.postMessage({ type: EdgeAuthTokenRequest }, "*");
});
}
_handleEdgeAuthTokenRequest(evt) {
const message = evt.data;
if (!message || !message.type || message.type !== EdgeAuthTokenRequest) {
return;
}
if (!evt.source) {
return;
}
const token = this._getAuthCookieToken();
evt.source.postMessage({ type: EdgeAuthTokenResponse, data: { token } });
}
_onConnectionMessage(evt) {
const rawMessage = JSON.parse(evt.data);
@ -4113,6 +4175,9 @@ var Edge = (() => {
}
_handleWindowMessage(evt) {
const message = evt.data;
if (!message || !message.type || !message.data) {
return;
}
const event = new CustomEvent(message.type, {
cancelable: true,
detail: message.data
@ -4136,27 +4201,15 @@ var Edge = (() => {
}
_initResizeObserver() {
const resizeObserver = new ResizeObserver(() => {
const body2 = document.body, html = document.documentElement;
const height = Math.max(
body2.scrollHeight,
body2.offsetHeight,
html.clientHeight,
html.scrollHeight,
html.offsetHeight
);
const width = Math.max(
body2.scrollWidth,
body2.offsetWidth,
html.clientWidth,
html.scrollWidth,
html.offsetWidth
);
const rect = document.documentElement.getBoundingClientRect();
const height = rect.height;
const width = rect.width;
this.post({ type: "size_changed" /* SIZE_CHANGED */, data: { height, width } });
});
const body = document.body;
if (!body)
return;
resizeObserver.observe(body);
resizeObserver.observe(document.documentElement);
}
};

File diff suppressed because one or more lines are too long

View File

@ -5,6 +5,8 @@ import SockJS from 'sockjs-client';
const EventTypeMessage = "message";
const EdgeAuth = "edge-auth"
const EdgeAuthTokenRequest = "edge_auth_token_request"
const EdgeAuthTokenResponse = "edge_auth_token_reponse"
export class Client extends EventTarget {
@ -19,10 +21,11 @@ export class Client extends EventTarget {
constructor(autoReconnect = true) {
super();
this._conn = null;
this._onConnectionClose = this._onConnectionClose.bind(this);
this._onConnectionMessage = this._onConnectionMessage.bind(this);
this._handleRPCResponse = this._handleRPCResponse.bind(this);
this._handleEdgeAuthTokenRequest = this._handleEdgeAuthTokenRequest.bind(this);
this._rpcID = 0;
this._pendingRPC = {};
@ -30,70 +33,146 @@ export class Client extends EventTarget {
this._reconnectionDelay = 250;
this._autoReconnect = autoReconnect;
this.debug = false;
this.connect = this.connect.bind(this);
this.disconnect = this.disconnect.bind(this);
this.rpc = this.rpc.bind(this);
this.send = this.send.bind(this);
this.upload = this.upload.bind(this);
this.addEventListener(EventTypeMessage, this._handleRPCResponse);
window.addEventListener('message', this._handleEdgeAuthTokenRequest);
}
connect(token = "") {
return new Promise((resolve, reject) => {
if (token == "") {
token = this._getAuthCookieToken()
}
connect(token = ""): Promise<Client> {
let getToken: Promise<string>
const url = `//${document.location.host}/edge/sock?${EdgeAuth}=${token}`;
this._log("opening connection to", url);
const conn: any = new SockJS(url);
if (token) {
getToken = Promise.resolve(token)
} else {
getToken = this._retrieveToken()
}
const onOpen = () => {
this._log('client connected');
resetHandlers();
conn.onclose = this._onConnectionClose;
conn.onmessage = this._onConnectionMessage;
this._conn = conn;
this._sendQueued();
setTimeout(() => {
this._dispatchConnect();
}, 0);
return resolve(this);
};
const onError = (evt) => {
resetHandlers();
this._scheduleReconnection();
return reject(evt);
};
const resetHandlers = () => {
conn.removeEventListener('open', onOpen);
conn.removeEventListener('close', onError);
conn.removeEventListener('error', onError);
};
conn.addEventListener('open', onOpen);
conn.addEventListener('error', onError);
conn.addEventListener('close', onError);
});
return getToken.then(token => this._connect(token))
}
disconnect() {
this._cleanupConnection();
}
_getAuthCookieToken() {
const cookie = document.cookie.split("; ")
.find((row) => row.startsWith(EdgeAuth));
if (cookie) {
return cookie.split("=")[1];
_connect(token: string): Promise<Client> {
return new Promise((resolve, reject) => {
const url = `//${document.location.host}/edge/sock?${EdgeAuth}=${token}`;
this._log("opening connection to", url);
const conn: any = new SockJS(url);
const onOpen = () => {
this._log('client connected');
resetHandlers();
conn.onclose = this._onConnectionClose;
conn.onmessage = this._onConnectionMessage;
this._conn = conn;
this._sendQueued();
setTimeout(() => {
this._dispatchConnect();
}, 0);
return resolve(this);
};
const onError = (evt) => {
resetHandlers();
this._scheduleReconnection();
return reject(evt);
};
const resetHandlers = () => {
conn.removeEventListener('open', onOpen);
conn.removeEventListener('close', onError);
conn.removeEventListener('error', onError);
};
conn.addEventListener('open', onOpen);
conn.addEventListener('error', onError);
conn.addEventListener('close', onError);
})
}
_retrieveToken(): Promise<string> {
let token = this._getAuthCookieToken();
if (token) {
return Promise.resolve(token);
}
return "";
return this._getParentFrameToken();;
}
_getAuthCookieToken(): string {
const cookie = document.cookie.split("; ")
.find((row) => row.startsWith(EdgeAuth));
let token = "";
if (cookie) {
token = cookie.split("=")[1];
}
return token;
}
_getParentFrameToken(timeout = 5000): Promise<string> {
if (!window.parent || window.parent === window) {
return Promise.resolve("");
}
return new Promise((resolve, reject) => {
let timedOut = false;
const timeoutId = setTimeout(() => {
timedOut = true;
reject(new Error("Edge auth token request timed out !"));
}, timeout);
const listener = (evt) => {
const message = evt.data;
if (!message || !message.type || !message.data) {
return
}
if (message.type !== EdgeAuthTokenResponse) {
return;
}
window.parent.removeEventListener('message', listener);
clearTimeout(timeoutId);
if (timedOut) return;
if (!message.data || !message.data.token) {
reject("Unexpected auth token request response !");
return;
}
resolve(message.data.token);
}
window.parent.addEventListener('message', listener);
window.parent.postMessage({ type: EdgeAuthTokenRequest }, '*');
})
}
_handleEdgeAuthTokenRequest(evt: MessageEvent) {
const message = evt.data;
if (!message || !message.type || message.type !== EdgeAuthTokenRequest) {
return;
}
if (!evt.source) {
return;
}
const token = this._getAuthCookieToken();
evt.source.postMessage({ type: EdgeAuthTokenResponse, data: { token }});
}
_onConnectionMessage(evt) {
@ -108,7 +187,7 @@ export class Client extends EventTarget {
_handleRPCResponse(evt) {
const { jsonrpc, id, error, result } = evt.detail;
if (jsonrpc !== '2.0' || id === undefined) return;
if (!evt.detail.hasOwnProperty("error") && !evt.detail.hasOwnProperty("result")) return;
@ -216,20 +295,20 @@ export class Client extends EventTarget {
return this._conn !== null;
}
upload(blob: string|Blob, metadata: any) {
upload(blob: string | Blob, metadata: any) {
return new Promise((resolve, reject) => {
const formData = new FormData();
formData.set("file", blob);
if (metadata) {
try {
formData.set("metadata", JSON.stringify(metadata));
} catch(err) {
} catch (err) {
return reject(err);
}
}
const xhr = new XMLHttpRequest();
const result = {
onProgress: null,
abort: () => xhr.abort(),
@ -239,7 +318,7 @@ export class Client extends EventTarget {
let data;
try {
data = JSON.parse(xhr.responseText);
} catch(err) {
} catch (err) {
reject(err);
return;
}

View File

@ -37,6 +37,10 @@ export class CrossFrameMessenger extends EventTarget {
_handleWindowMessage(evt: MessageEvent) {
const message = evt.data;
if (!message || !message.type || !message.data) {
return;
}
const event = new CustomEvent(message.type, {
cancelable: true,
detail: message.data
@ -67,14 +71,9 @@ export class CrossFrameMessenger extends EventTarget {
_initResizeObserver() {
const resizeObserver = new ResizeObserver(() => {
const body = document.body,
html = document.documentElement;
const height = Math.max( body.scrollHeight, body.offsetHeight,
html.clientHeight, html.scrollHeight, html.offsetHeight );
const width = Math.max( body.scrollWidth, body.offsetWidth,
html.clientWidth, html.scrollWidth, html.offsetWidth );
const rect = document.documentElement.getBoundingClientRect();
const height = rect.height;
const width = rect.width;
this.post({ type: CrossFrameMessageType.SIZE_CHANGED, data: { height, width }});
});
@ -83,6 +82,6 @@ export class CrossFrameMessenger extends EventTarget {
if (!body) return;
resizeObserver.observe(body);
resizeObserver.observe(document.documentElement);
}
}

View File

@ -25,7 +25,7 @@ func Open(path string) (*sql.DB, error) {
func withTx(ctx context.Context, db *sql.DB, fn func(tx *sql.Tx) error) error {
var tx *sql.Tx
tx, err := db.Begin()
tx, err := db.BeginTx(ctx, nil)
if err != nil {
return errors.WithStack(err)
}