microcosm.blue
Add getCounts XRPC equivalent to REST /links/count
Simple conversion of the existing endpoint from REST to XRPC. Consequtively marked the pre-existing REST endpoint as deprecated.
In addition we now ignore rocks.test
+266
-26
Diff
round #2
+47
constellation/src/server/mod.rs
+47
constellation/src/server/mod.rs
···
77
}
78
}),
79
)
80
.route(
81
"/links/count/distinct-dids",
82
get({
···
343
#[serde(skip_serializing)]
344
query: GetLinksCountQuery,
345
}
346
fn count_links(
347
accept: ExtractAccept,
348
query: Query<GetLinksCountQuery>,
···
360
))
361
}
362
363
#[derive(Clone, Deserialize)]
364
struct GetDidsCountQuery {
365
target: String,
···
659
#[serde(skip_serializing)]
660
query: GetAllLinksQuery,
661
}
662
fn count_all_links(
663
accept: ExtractAccept,
664
query: Query<GetAllLinksQuery>,
···
77
}
78
}),
79
)
80
+
.route(
81
+
"/xrpc/blue.microcosm.links.getCounts",
82
+
get({
83
+
let store = store.clone();
84
+
move |accept, query| async {
85
+
spawn_blocking(|| get_counts(accept, query, store))
86
+
.await
87
+
.map_err(to500)?
88
+
}
89
+
}),
90
+
)
91
.route(
92
"/links/count/distinct-dids",
93
get({
···
354
#[serde(skip_serializing)]
355
query: GetLinksCountQuery,
356
}
357
+
#[deprecated]
358
fn count_links(
359
accept: ExtractAccept,
360
query: Query<GetLinksCountQuery>,
···
372
))
373
}
374
375
+
#[derive(Clone, Deserialize)]
376
+
struct GetItemsCountQuery {
377
+
subject: String,
378
+
source: String,
379
+
}
380
+
#[derive(Template, Serialize)]
381
+
#[template(path = "get-counts.html.j2")]
382
+
struct GetItemsCountResponse {
383
+
total: u64,
384
+
#[serde(skip_serializing)]
385
+
query: GetItemsCountQuery,
386
+
}
387
+
fn get_counts(
388
+
accept: ExtractAccept,
389
+
query: axum_extra::extract::Query<GetItemsCountQuery>,
390
+
store: impl LinkReader,
391
+
) -> Result<impl IntoResponse, http::StatusCode> {
392
+
let Some((collection, path)) = query.source.split_once(':') else {
393
+
return Err(http::StatusCode::BAD_REQUEST);
394
+
};
395
+
let path = format!(".{path}");
396
+
let total = store
397
+
.get_count(&query.subject, collection, &path)
398
+
.map_err(|_| http::StatusCode::INTERNAL_SERVER_ERROR)?;
399
+
400
+
Ok(acceptable(
401
+
accept,
402
+
GetItemsCountResponse {
403
+
total,
404
+
query: (*query).clone(),
405
+
},
406
+
))
407
+
}
408
+
409
#[derive(Clone, Deserialize)]
410
struct GetDidsCountQuery {
411
target: String,
···
705
#[serde(skip_serializing)]
706
query: GetAllLinksQuery,
707
}
708
+
#[deprecated]
709
fn count_all_links(
710
accept: ExtractAccept,
711
query: Query<GetAllLinksQuery>,
+38
constellation/templates/get-counts.html.j2
+38
constellation/templates/get-counts.html.j2
···
···
1
+
{% extends "base.html.j2" %}
2
+
{% import "try-it-macros.html.j2" as try_it %}
3
+
4
+
{% block title %}Link Count{% endblock %}
5
+
{% block description %}Count of {{ query.source }} records linking to {{ query.subject }}{% endblock %}
6
+
7
+
{% block content %}
8
+
9
+
{% call try_it::get_counts(
10
+
query.subject,
11
+
query.source,
12
+
) %}
13
+
14
+
<h2>
15
+
Total links to <code>{{ query.subject }}</code>
16
+
{% if let Some(browseable_uri) = query.subject|to_browseable %}
17
+
<small style="font-weight: normal; font-size: 1rem"><a href="{{ browseable_uri }}">browse record</a></small>
18
+
{% endif %}
19
+
</h2>
20
+
21
+
<p><strong><code>{{ total|human_number }}</code></strong> total links from <code>{{ query.source }}</code> to <code>{{ query.subject }}</code></p>
22
+
23
+
<ul>
24
+
<li>
25
+
See direct backlinks at <code>/xrpc/blue.microcosm.links.getBacklinks</code>:
26
+
<a href="/xrpc/blue.microcosm.links.getBacklinks?subject={{ query.subject|urlencode }}&source={{ query.source|urlencode }}">
27
+
/xrpc/blue.microcosm.links.getBacklinks?subject={{ query.subject }}&source={{ query.source }}
28
+
</a>
29
+
</li>
30
+
<li>See all links to this target at <code>/links/all</code>: <a href="/links/all?target={{ query.subject|urlencode }}">/links/all?target={{ query.subject }}</a></li>
31
+
</ul>
32
+
33
+
<details>
34
+
<summary>Raw JSON response</summary>
35
+
<pre class="code">{{ self|tojson }}</pre>
36
+
</details>
37
+
38
+
{% endblock %}
+13
constellation/templates/hello.html.j2
+13
constellation/templates/hello.html.j2
···
134
<p style="margin-bottom: 0"><strong>Try it:</strong></p>
135
{% call try_it::links_count("did:plc:vc7f4oafdgxsihk4cry2xpze", "app.bsky.graph.block", ".subject") %}
136
137
+
<h3 class="route"><code>GET /xrpc/blue.microcosm.links.getCounts</code></h3>
138
+
139
+
<p>The total number of links pointing at a given target.</p>
140
+
141
+
<h4>Query parameters:</h4>
142
+
143
+
<ul>
144
+
<li><code>subject</code>: required, must url-encode. The target being linked to. Example: <code>did:plc:vc7f4oafdgxsihk4cry2xpze</code> or <code>at://did:plc:vc7f4oafdgxsihk4cry2xpze/app.bsky.feed.post/3lgwdn7vd722r</code></li>
145
+
<li><code>source</code>: required. Collection and path specification for the primary link. Example: <code>app.bsky.feed.like:subject.uri</code></li>
146
+
</ul>
147
+
148
+
<p style="margin-bottom: 0"><strong>Try it:</strong></p>
149
+
{% call try_it::get_counts("did:plc:vc7f4oafdgxsihk4cry2xpze", "app.bsky.graph.block:subject.uri") %}
150
151
<h3 class="route"><code>GET /links/count/distinct-dids</code></h3>
152
+10
constellation/templates/try-it-macros.html.j2
+10
constellation/templates/try-it-macros.html.j2
···
102
</form>
103
{% endmacro %}
104
105
+
{% macro get_counts(subject, source) %}
106
+
<form method="get" action="/xrpc/blue.microcosm.links.getCounts">
107
+
<pre class="code">
108
+
<strong>GET</strong> /xrpc/blue.microcosm.links.getCounts
109
+
?subject= <input type="text" name="subject" value="{{ subject }}" placeholder="subject" />
110
+
&source= <input type="text" name="source" value="{{ source }}" placeholder="source" />
111
+
<button type="submit">get links count</button>
112
+
</pre>
113
+
</form>
114
+
{% endmacro %}
115
116
{% macro links_count(target, collection, path) %}
117
<form method="get" action="/links/count">
+3
-13
lexicons/blue.microcosm/links/getBacklinks.json
+3
-13
lexicons/blue.microcosm/links/getBacklinks.json
···
7
"description": "a list of records linking to any record, identity, or uri",
8
"parameters": {
9
"type": "params",
10
-
"required": [
11
-
"subject",
12
-
"source"
13
-
],
14
"properties": {
15
"subject": {
16
"type": "string",
···
42
"encoding": "application/json",
43
"schema": {
44
"type": "object",
45
-
"required": [
46
-
"total",
47
-
"records"
48
-
],
49
"properties": {
50
"total": {
51
"type": "integer",
···
68
},
69
"linkRecord": {
70
"type": "object",
71
-
"required": [
72
-
"did",
73
-
"collection",
74
-
"rkey"
75
-
],
76
"properties": {
77
"did": {
78
"type": "string",
···
7
"description": "a list of records linking to any record, identity, or uri",
8
"parameters": {
9
"type": "params",
10
+
"required": ["subject", "source"],
11
"properties": {
12
"subject": {
13
"type": "string",
···
39
"encoding": "application/json",
40
"schema": {
41
"type": "object",
42
+
"required": ["total", "records"],
43
"properties": {
44
"total": {
45
"type": "integer",
···
62
},
63
"linkRecord": {
64
"type": "object",
65
+
"required": ["did", "collection", "rkey"],
66
"properties": {
67
"did": {
68
"type": "string",
+38
lexicons/blue.microcosm/links/getCounts.json
+38
lexicons/blue.microcosm/links/getCounts.json
···
···
1
+
{
2
+
"lexicon": 1,
3
+
"id": "blue.microcosm.links.getCounts",
4
+
"defs": {
5
+
"main": {
6
+
"type": "query",
7
+
"description": "count records that link to another record",
8
+
"parameters": {
9
+
"type": "params",
10
+
"required": ["subject", "source"],
11
+
"properties": {
12
+
"subject": {
13
+
"type": "string",
14
+
"format": "uri",
15
+
"description": "the primary target being linked to (at-uri, did, or uri)"
16
+
},
17
+
"source": {
18
+
"type": "string",
19
+
"description": "collection and path specification for the primary link"
20
+
}
21
+
}
22
+
},
23
+
"output": {
24
+
"encoding": "application/json",
25
+
"schema": {
26
+
"type": "object",
27
+
"required": ["total"],
28
+
"properties": {
29
+
"total": {
30
+
"type": "integer",
31
+
"description": "total number of matching links"
32
+
}
33
+
}
34
+
}
35
+
}
36
+
}
37
+
}
38
+
}
+109
lexicons/blue.microcosm/links/getManyToMany.json
+109
lexicons/blue.microcosm/links/getManyToMany.json
···
···
1
+
{
2
+
"lexicon": 1,
3
+
"id": "blue.microcosm.links.getManyToMany",
4
+
"defs": {
5
+
"main": {
6
+
"type": "query",
7
+
"description": "Get records that link to a primary subject, grouped by the secondary subjects they also reference",
8
+
"parameters": {
9
+
"type": "params",
10
+
"required": ["subject", "source", "pathToOther"],
11
+
"properties": {
12
+
"subject": {
13
+
"type": "string",
14
+
"format": "uri",
15
+
"description": "the primary target being linked to (at-uri, did, or uri)"
16
+
},
17
+
"source": {
18
+
"type": "string",
19
+
"description": "collection and path specification for the primary link (e.g., 'app.bsky.feed.like:subject.uri')"
20
+
},
21
+
"pathToOther": {
22
+
"type": "string",
23
+
"description": "path to the secondary link in the many-to-many record (e.g., 'otherThing.uri')"
24
+
},
25
+
"did": {
26
+
"type": "array",
27
+
"description": "filter links to those from specific users",
28
+
"items": {
29
+
"type": "string",
30
+
"format": "did"
31
+
}
32
+
},
33
+
"otherSubject": {
34
+
"type": "array",
35
+
"description": "filter secondary links to specific subjects",
36
+
"items": {
37
+
"type": "string"
38
+
}
39
+
},
40
+
"limit": {
41
+
"type": "integer",
42
+
"minimum": 1,
43
+
"maximum": 100,
44
+
"default": 16,
45
+
"description": "number of results to return"
46
+
}
47
+
}
48
+
},
49
+
"output": {
50
+
"encoding": "application/json",
51
+
"schema": {
52
+
"type": "object",
53
+
"required": ["linking_records"],
54
+
"properties": {
55
+
"linking_records": {
56
+
"type": "array",
57
+
"items": {
58
+
"type": "ref",
59
+
"ref": "#recordsBySubject"
60
+
}
61
+
},
62
+
"cursor": {
63
+
"type": "string",
64
+
"description": "pagination cursor"
65
+
}
66
+
}
67
+
}
68
+
}
69
+
},
70
+
"recordsBySubject": {
71
+
"type": "object",
72
+
"required": ["subject", "records"],
73
+
"properties": {
74
+
"subject": {
75
+
"type": "string",
76
+
"description": "the secondary subject that these records link to"
77
+
},
78
+
"records": {
79
+
"type": "array",
80
+
"items": {
81
+
"type": "ref",
82
+
"ref": "#linkRecord"
83
+
}
84
+
}
85
+
}
86
+
},
87
+
"linkRecord": {
88
+
"type": "object",
89
+
"required": ["did", "collection", "rkey"],
90
+
"description": "A record identifier consisting of a DID, collection, and record key",
91
+
"properties": {
92
+
"did": {
93
+
"type": "string",
94
+
"format": "did",
95
+
"description": "the DID of the linking record's repository"
96
+
},
97
+
"collection": {
98
+
"type": "string",
99
+
"format": "nsid",
100
+
"description": "the collection of the linking record"
101
+
},
102
+
"rkey": {
103
+
"type": "string",
104
+
"format": "record-key"
105
+
}
106
+
}
107
+
}
108
+
}
109
+
}
+3
-13
lexicons/blue.microcosm/links/getManyToManyCounts.json
+3
-13
lexicons/blue.microcosm/links/getManyToManyCounts.json
···
7
"description": "count many-to-many relationships with secondary link paths",
8
"parameters": {
9
"type": "params",
10
-
"required": [
11
-
"subject",
12
-
"source",
13
-
"pathToOther"
14
-
],
15
"properties": {
16
"subject": {
17
"type": "string",
···
54
"encoding": "application/json",
55
"schema": {
56
"type": "object",
57
-
"required": [
58
-
"counts_by_other_subject"
59
-
],
60
"properties": {
61
"counts_by_other_subject": {
62
"type": "array",
···
75
},
76
"countBySubject": {
77
"type": "object",
78
-
"required": [
79
-
"subject",
80
-
"total",
81
-
"distinct"
82
-
],
83
"properties": {
84
"subject": {
85
"type": "string",
···
7
"description": "count many-to-many relationships with secondary link paths",
8
"parameters": {
9
"type": "params",
10
+
"required": ["subject", "source", "pathToOther"],
11
"properties": {
12
"subject": {
13
"type": "string",
···
50
"encoding": "application/json",
51
"schema": {
52
"type": "object",
53
+
"required": ["counts_by_other_subject"],
54
"properties": {
55
"counts_by_other_subject": {
56
"type": "array",
···
69
},
70
"countBySubject": {
71
"type": "object",
72
+
"required": ["subject", "total", "distinct"],
73
"properties": {
74
"subject": {
75
"type": "string",
History
8 rounds
13 comments
seoul.systems
submitted
#7
8 commits
expand
collapse
Add getCounts XRPC equivalent to REST /links/count
Simple conversion of the existing endpoint from REST to XRPC.
Consequtively marked the pre-existing REST endpoint as deprecated.
In addition we now ignore rocks.test
# Conflicts:
# constellation/src/storage/mod.rs
# lexicons/blue.microcosm/links/getManyToMany.json
Modify backlinks counting XRPC endpoint name
Now matches the existing XRPC getBacklinks endpoint naming scheme.
This should fix the white-space issue for the` try-it-macros` template as
well.
Mark /links/count REST endpoint as deprecated
Remove
.uri suffix
Reformat existing lexicons
Remove wrongly commited getManyToMany lexicon
This belongs to the xrpc_many2many branch.
Fix Git whitespace error in "hello" template
Format .prettierrc and fix Git whitespace error
expand 3 comments
happy to do merging locally as needed!
merged. thanks!
closed without merging
seoul.systems
submitted
#6
7 commits
expand
collapse
Add getCounts XRPC equivalent to REST /links/count
Simple conversion of the existing endpoint from REST to XRPC.
Consequtively marked the pre-existing REST endpoint as deprecated.
In addition we now ignore rocks.test
# Conflicts:
# constellation/src/storage/mod.rs
# lexicons/blue.microcosm/links/getManyToMany.json
Modify backlinks counting XRPC endpoint name
Now matches the existing XRPC getBacklinks endpoint naming scheme.
This should fix the white-space issue for the` try-it-macros` template as
well.
Mark /links/count REST endpoint as deprecated
Remove
.uri suffix
Reformat existing lexicons
Remove wrongly commited getManyToMany lexicon
This belongs to the xrpc_many2many branch.
Fix Git whitespace error in "hello" template
expand 0 comments
seoul.systems
submitted
#5
6 commits
expand
collapse
Add getCounts XRPC equivalent to REST /links/count
Simple conversion of the existing endpoint from REST to XRPC.
Consequtively marked the pre-existing REST endpoint as deprecated.
In addition we now ignore rocks.test
# Conflicts:
# constellation/src/storage/mod.rs
# lexicons/blue.microcosm/links/getManyToMany.json
Modify backlinks counting XRPC endpoint name
Now matches the existing XRPC getBacklinks endpoint naming scheme.
This should fix the white-space issue for the` try-it-macros` template as
well.
Mark /links/count REST endpoint as deprecated
Remove
.uri suffix
Reformat existing lexicons
Remove wrongly commited getManyToMany lexicon
This belongs to the xrpc_many2many branch.
expand 0 comments
seoul.systems
submitted
#4
3 commits
expand
collapse
Add getCounts XRPC equivalent to REST /links/count
Simple conversion of the existing endpoint from REST to XRPC.
Consequtively marked the pre-existing REST endpoint as deprecated.
In addition we now ignore rocks.test
# Conflicts:
# constellation/src/storage/mod.rs
# lexicons/blue.microcosm/links/getManyToMany.json
Modify backlinks counting XRPC endpoint name
Now matches the existing XRPC getBacklinks endpoint naming scheme.
This should fix the white-space issue for the` try-it-macros` template as
well.
Mark /links/count REST endpoint as deprecated
expand 4 comments
Tangled somehow complains about merge conflicts here, but I couldn't find any after rebasing on upstream/main again?!
very weird!
one tiny thing left: the source for blocks is app.bsky.graph.block:subject (no .uri suffix on the path) -- it's in the hello.html template.
i think some many-to-many order stuff ended up on this branch but i'm too tired for git rn.
if you don't get to it first i'm happy to fix the source and git stuff and merge when i can get to it :)
Sorry about the the m2m stuff that I didn't catch before opening the PR. I did clean this up again, and nothing belonging there should be remaining here; Addresses your above comment regarding the .uri suffix as well.
seoul.systems
submitted
#3
3 commits
expand
collapse
Add getCounts XRPC equivalent to REST /links/count
Simple conversion of the existing endpoint from REST to XRPC.
Consequtively marked the pre-existing REST endpoint as deprecated.
In addition we now ignore rocks.test
# Conflicts:
# constellation/src/storage/mod.rs
# lexicons/blue.microcosm/links/getManyToMany.json
Modify backlinks counting XRPC endpoint name
Now matches the existing XRPC getBacklinks endpoint naming scheme.
This should fix the white-space issue for the` try-it-macros` template as
well.
Mark /links/count REST endpoint as deprecated
expand 0 comments
seoul.systems
submitted
#2
1 commit
expand
collapse
Add getCounts XRPC equivalent to REST /links/count
Simple conversion of the existing endpoint from REST to XRPC.
Consequtively marked the pre-existing REST endpoint as deprecated.
In addition we now ignore rocks.test
# Conflicts:
# constellation/src/storage/mod.rs
# lexicons/blue.microcosm/links/getManyToMany.json
expand 6 comments
Had to do some rebasing and cleanup, but good to go now I think.
sweet!
(btw the local/ gitignore is there for doing local/rocks.test, but i'm fine adding it to the top-level gitignore too!)
i think links.getCounts is a little too broad -- what do you think of links.getBacklinksCount?
we also throw a deprecated warning under /links/count on the main page template, matching the one for /links.
it's weird but the whitespace in the forms in try-it-macros is significant (one of my moments of knowingly doing things the wrong way because i was bored, sorry!)
the new form for this endpoint needs little tweaking to match the others.
Ah got it. The rocks tests ended up cluttering the top-level directory so I just added them to .gitignore. I often keep a .local file in .gitignores to ignore whatever's supposed to stay in one's local copy and somehow assumed this had the same intent.
Changed the function and endpoint/method name as requested to get_backlinks_count/getBacklinksCount
The endpoint in the try-it-macro should now match the other existing ones down to how they're formatted with whitespace
seoul.systems
submitted
#1
3 commits
expand
collapse
Make metrics collection opt-in
Adds a new --collect-metrics (presence) flag to make metrics collection
opt-in. The new default is to __not__ collect any metrics, i.e. neither
spawning the monitoring thread nor starting the metrics server server
that exposes these.
Increase constellation response limits
As outlined in the description of issue #4 we increase:
- the default response limit from 16 to __100__
- the maximum from 100 to __1000_
Add getCounts XRPC equivalent to REST /links/count
Simple conversion of the existing endpoint from REST to XRPC.
Consequtively marked the pre-existing REST endpoint as deprecated.
In addition we now ignore rocks.test
# Conflicts:
# constellation/src/storage/mod.rs
# lexicons/blue.microcosm/links/getManyToMany.json
expand 0 comments
seoul.systems
submitted
#0
7 commits
expand
collapse
Make metrics collection opt-in
Adds a new --collect-metrics (presence) flag to make metrics collection
opt-in. The new default is to __not__ collect any metrics, i.e. neither
spawning the monitoring thread nor starting the metrics server server
that exposes these.
Increase constellation response limits
As outlined in the description of issue #4 we increase:
- the default response limit from 16 to __100__
- the maximum from 100 to __1000_
wip: m2m
Add tests for new get_many_to_many query handler
Fix get_m2m_empty test
Replace tuple with RecordsBySubject struct
Replace (String, Vec<RecordId>) tuples with a proper
RecordsBySubject struct throughout the many-to-many query
implementation as Lexicons per ATProto spec do not offer a tuple type.
Add lexicon definition for the getManyToMany XRPC endpoint.
Add getCounts XRPC equivalent to REST /links/count
Simple conversion of the existing endpoint from REST to XRPC.
Consequtively marked the pre-existing REST endpoint as deprecated.
In addition we now ignore rocks.test
I'm giving up on the whitespace issue...
git-diff --checkeddoesn't indicate any errors either.As far as I can tell this seems to be a confirmed Tangled issue