Skip to content

Commit 4b7ffa9

Browse files
authored
Merge pull request #302 from ably/add-cli-agent-support
Add support for ably-cli in agents header
2 parents 3fc3012 + 3661b38 commit 4b7ffa9

File tree

2 files changed

+11
-26
lines changed

2 files changed

+11
-26
lines changed

protocol/README.md

Lines changed: 6 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,11 @@ When a new agent is added to a client library, add a corresponding entry to [age
7676
using the schema defined in [agents-schema.json](../json-schemas/src/agents.json), and open a pull
7777
request against the `main` branch with those changes.
7878

79-
Once the pull request is merged into `main`, open an internal ticket requesting that the realtime team
80-
follow the "Publishing Changes" steps below.
79+
#### Analytics pipeline support
80+
81+
The agents are replicated in the analytics pipeline that processes agent headers. See [udtf_parse_ably_agent.py](https://github.com/ably/infrastructure/blob/main/terraform/modules/analytics/snowflake/files/functions/udtf_parse_ably_agent.py).
82+
83+
Once the pull request is merged into `main`, notify the Data / Infrastructure team of the changes to agents.json so that they can update the analytics data pipeine to support the newly added agents.
8184

8285
### Additional Notes on Agents
8386

@@ -93,6 +96,7 @@ The following table adds more contextual detail for some agent identifiers, wher
9396
| ---------- | -------- |
9497
| `ably-asset-tracking-android` | [ably-asset-tracking-android](https://github.com/ably/ably-asset-tracking-android) |
9598
| `ably-asset-tracking-swift` | [ably-asset-tracking-swift](https://github.com/ably/ably-asset-tracking-swift) |
99+
| `ably-cli` | [ably-cli command line CLI too](https://github.com/ably/cli) |
96100
| `ably-flutter` | [ably-flutter](https://github.com/ably/ably-flutter) |
97101
| `ably-ruby-rest` | [ably-ruby](https://github.com/ably/ably-ruby) |
98102
| `android` | [ably-java](https://github.com/ably/ably-java), [ably-dotnet](https://github.com/ably/ably-dotnet) |
@@ -130,30 +134,6 @@ The following table adds more contextual detail for some agent identifiers, wher
130134
| `windows` | [ably-dotnet](https://github.com/ably/ably-dotnet), [ably-go](https://github.com/ably/ably-go) |
131135
| `xamarin` | [ably-dotnet](https://github.com/ably/ably-dotnet) |
132136

133-
### Publishing Changes
134-
135-
#### Step 1: Public
136-
137-
After changes to [agents.json](agents.json) have been merged into `main`, update the generated Go code
138-
in the [ably-common-go](https://github.com/ably/ably-common-go) repository by manually triggering the
139-
[publish workflow](../.github/workflows/publish.yml) (see [here](https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow)
140-
for instructions on how to do that).
141-
142-
There is no further, immediate downstream impact of publishing to `ably-common-go` like this.
143-
Therefore it is safe to publish without consulting others because they have an explicit step required to update the submodule in their codebase (see [Step 2: Internal](#step-2-internal)).
144-
145-
#### Step 2: Internal
146-
147-
Once the generated Go code has been updated, update the `ably-common-go` module in the
148-
internal [go-services](https://github.com/ably/go-services) repository by running:
149-
150-
```bash
151-
go get -u github.com/ably/ably-common-go
152-
```
153-
154-
Open a pull request with the resulting changes to `go.mod` and `go.sum`, and once merged deploy the router
155-
so that it's aware of the newly added agent identifiers.
156-
157137
### `ablyLibMappings`
158138

159139
The `ablyLibMappings` field in [agents.json](agents.json) provides continuity for SDKs that continue to send the

protocol/agents.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -364,6 +364,11 @@
364364
"identifier": "chat-swift",
365365
"versioned": true,
366366
"type": "wrapper"
367+
},
368+
{
369+
"identifier": "ably-cli",
370+
"versioned": true,
371+
"type": "wrapper"
367372
}
368373
],
369374
"ablyLibMappings": {

0 commit comments

Comments
 (0)