Created base action (#1)

Created the core action to output the fellows GitHub handle.

This action is intended to be used with other actions that needs it
(like
[`paritytech/auto-merge-bot`](https://github.com/paritytech/auto-merge-bot)
in the runtimes repository).

Author: Bullrich

README.md

@@ -1,9 +1,47 @@
-# Parity GitHub Action template
+# Get Fellows Action
 
-Template used to generate GitHub Actions.
+GitHub action to fetch all the fellows information.
 
-## To start
+This action fetches all the fellows from the [on-chain data](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Fkusama-rpc.polkadot.io#/fellowship) and output two objects with the fellows data and with the users’ GitHub information.
 
-- Remember to modify the `action.yml` file to have your required attributes and details. 
- - You can use [GitHub Action Brandings cheatsheet](https://github.com/haya14busa/github-action-brandings) to set the style of the action.
-- Remember to modify the name in the `package.json`.
+It looks in the fellows data for a field named `GitHub` and it extracts the handle from there.
+
+This action is intended to be chained with other actions that requires the fellows GitHub handles.
+
+## Installation
+This action is intended to be chained with other actions. It does not have any requirements.
+
+We simply need to add the step:
+```yaml
+- uses: paritytech/get-fellows-action
+  id: fellows
+```
+
+A working example where we print all the names is the following:
+```yaml
+name: Mention fellows
+
+on: [push]
+
+jobs:
+  mention-fellows:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: paritytech/get-fellows-action
+        id: fellows
+      - name: Mention them
+        run: |
+          echo "The fellows are $FELLOWS"
+        env:
+          # the handles of the fellows separated by commas
+          FELLOWS: ${{ steps.fellows.outputs.github-handles }}"
+```
+
+### Outputs
+You can find all the outputs in the [`action.yml` file](./action.yml).
+
+They are:
+- `fellows`: A JSON array with objects of type  "address": "1e2345...", "rank": rank (as a number), “githubHandle”: “handle (can be null)”
+	- Example: `[{"address":"1e2345...",rank: 4, "githubHandle":"user-1"},{"address":"1e4532...",rank: 3, "githubHandle":"user-2"},{"address":"1e8335...",rank: 6}]`
+- `github-handles`: All the fellows handles separated by commas
+	- Example: `user-1,user-2,user-3`

action.yml

@@ -1,16 +1,14 @@
-name: "Example Action"
-description: "This values need to be changed"
+name: "get-fellows-action"
+description: "Fetch all the GitHub handles from the Fellows"
 author: Bullrich
 branding:
-  icon: copy
-  color: yellow
-inputs:
-  GITHUB_TOKEN:
-    required: true
-    description: The token to access the repo
+  icon: users
+  color: red
 outputs:
-  repo:
-    description: 'The name of the repo in owner/repo pattern'
+  fellows-handles:
+    description: 'A JSON array with objects of type { "address": "1e2345...", "rank": rank (as a number), githubHandle: "can be null" }'
+  github-handles:
+    description: "All the fellows' Github handles separated by commas"
 
 runs:
   using: 'docker'

jest.config.js

@@ -2,5 +2,6 @@
 module.exports = {
   preset: "ts-jest",
   testEnvironment: "node",
+  testTimeout: 20_000,
   testMatch: [__dirname + "/src/**/test/**/*.ts"],
 };

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "parity-action-template",
+  "name": "get-fellows-action",
   "version": "0.0.1",
-  "description": "GitHub action template for Parity",
+  "description": "Fetch all the GitHub handles from the Fellows",
   "main": "src/index.ts",
   "scripts": {
     "start": "node dist",
@@ -23,13 +23,15 @@
   "dependencies": {
     "@actions/core": "^1.10.1",
     "@actions/github": "^5.1.1",
-    "@octokit/webhooks-types": "^7.3.1"
+    "@octokit/webhooks-types": "^7.3.1",
+    "@polkadot/api": "^10.9.1"
   },
   "devDependencies": {
     "@eng-automation/js-style": "^2.3.0",
     "@types/jest": "^29.5.5",
     "@vercel/ncc": "^0.38.0",
     "jest": "^29.7.0",
+    "jest-mock-extended": "^3.0.5",
     "ts-jest": "^29.1.1",
     "typescript": "^5.2.2"
   }

src/fellows.ts

@@ -0,0 +1,102 @@
+/* eslint-disable @typescript-eslint/ban-ts-comment */
+import { ApiPromise, WsProvider } from "@polkadot/api";
+
+import { ActionLogger } from "./github/types";
+
+type FellowData = { address: string; rank: number };
+
+export type FellowObject = {
+  address: string;
+  githubHandle?: string;
+  rank: number;
+};
+
+export const fetchAllFellows = async (
+  logger: ActionLogger,
+): Promise<FellowObject[]> => {
+  let api: ApiPromise;
+  logger.debug("Connecting to collective parachain");
+  // we connect to the collective rpc node
+  const wsProvider = new WsProvider(
+    "wss://polkadot-collectives-rpc.polkadot.io",
+  );
+  api = await ApiPromise.create({ provider: wsProvider });
+  try {
+    // We fetch all the members
+    const membersObj = await api.query.fellowshipCollective.members.entries();
+
+    // We iterate over the fellow data and convert them into usable values
+    const fellows: FellowData[] = [];
+    for (const [key, rank] of membersObj) {
+      // @ts-ignore
+      const [address]: [string] = key.toHuman();
+      fellows.push({ address, ...(rank.toHuman() as object) } as FellowData);
+    }
+    logger.debug(JSON.stringify(fellows));
+
+    // Once we obtained this information, we disconnect this api.
+    await api.disconnect();
+
+    logger.debug("Connecting to relay parachain.");
+    // We connect to the relay chain
+    api = await ApiPromise.create({
+      provider: new WsProvider("wss://rpc.polkadot.io"),
+    });
+
+    // We iterate over the different members and extract their data
+    const users: FellowObject[] = [];
+    for (const fellow of fellows) {
+      logger.debug(
+        `Fetching identity of '${fellow.address}', rank: ${fellow.rank}`,
+      );
+      const fellowData = (
+        await api.query.identity.identityOf(fellow.address)
+      ).toHuman() as Record<string, unknown> | undefined;
+
+      let data: FellowObject = { address: fellow.address, rank: fellow.rank };
+
+      // If the identity is null, we ignore it.
+      if (!fellowData) {
+        logger.debug("Identity is null. Skipping");
+        continue;
+      }
+
+      // @ts-ignore
+      const additional = fellowData.info.additional as
+        | [{ Raw: string }, { Raw: string }][]
+        | undefined;
+
+      // If it does not have additional data (GitHub handle goes here) we ignore it
+      if (!additional || additional.length < 1) {
+        logger.debug("Additional data is null. Skipping");
+        continue;
+      }
+
+      for (const additionalData of additional) {
+        const [key, value] = additionalData;
+        // We verify that they have an additional data of the key "github"
+        // If it has a handle defined, we push it into the array
+        if (
+          key?.Raw &&
+          key?.Raw === "github" &&
+          value?.Raw &&
+          value?.Raw.length > 0
+        ) {
+          logger.debug(`Found handles: '${value.Raw}'`);
+          // We add it to the array and remove the @ if they add it to the handle
+          data = { ...data, githubHandle: value.Raw.replace("@", "") };
+        }
+      }
+      users.push(data);
+    }
+
+    logger.info(`Found users: ${JSON.stringify(Array.from(users.entries()))}`);
+
+    return users;
+  } catch (error) {
+    logger.error(error as Error);
+    throw error;
+  } finally {
+    await api.disconnect();
+  }
+};

src/github/pullRequest.ts

@@ -1,32 +1,17 @@
-import { getInput, info, setOutput } from "@actions/core";
-import { context, getOctokit } from "@actions/github";
-import { Context } from "@actions/github/lib/context";
-import { PullRequest } from "@octokit/webhooks-types";
+import { setFailed, setOutput } from "@actions/core";
 
-import { PullRequestApi } from "./github/pullRequest";
+import { FellowObject, fetchAllFellows } from "./fellows";
 import { generateCoreLogger } from "./util";
 
-const getRepo = (ctx: Context) => {
-  let repo = getInput("repo", { required: false });
-  if (!repo) {
-    repo = ctx.repo.repo;
-  }
+const logger = generateCoreLogger();
 
-  let owner = getInput("owner", { required: false });
-  if (!owner) {
-    owner = ctx.repo.owner;
-  }
-
-  return { repo, owner };
+const mapFellows = (fellows: FellowObject[]) => {
+  setOutput("fellows", JSON.stringify(fellows));
+  const githubHandles = fellows
+    .map((f) => f.githubHandle)
+    .filter((f) => !!f)
+    .join(",");
+  setOutput("github-handles", githubHandles);
 };
 
-const repo = getRepo(context);
-
-setOutput("repo", `${repo.owner}/${repo.repo}`);
-
-if (context.payload.pull_request) {
-  const token = getInput("GITHUB_TOKEN", { required: true });
-  const api = new PullRequestApi(getOctokit(token), generateCoreLogger());
-  const author = api.getPrAuthor(context.payload.pull_request as PullRequest);
-  info("Author of the PR is " + author);
-}
+fetchAllFellows(logger).then(mapFellows).catch(setFailed);

src/index.ts

@@ -0,0 +1,17 @@
+import { mock, MockProxy } from "jest-mock-extended";
+
+import { fetchAllFellows } from "../fellows";
+import { ActionLogger } from "../github/types";
+
+describe("Fellows test", () => {
+  let logger: MockProxy<ActionLogger>;
+
+  beforeEach(() => {
+    logger = mock<ActionLogger>();
+  });
+
+  test("Should fetch fellows", async () => {
+    const members = await fetchAllFellows(logger);
+    expect(members.length).toBeGreaterThan(0);
+  });
+});