Check for new Fly.io regions (#10)

* Add `Region::all()`

* Check for new Fly.io regions

Author: silverlyra

.github/workflows/ci.yml

@@ -10,7 +10,7 @@ jobs:
     name: Format
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: moonrepo/setup-rust@v1
         with:
           components: rustfmt
@@ -21,7 +21,7 @@ jobs:
     name: Lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: moonrepo/setup-rust@v1
         with:
           components: clippy
@@ -36,7 +36,7 @@ jobs:
     name: Test
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: moonrepo/setup-rust@v1
       - name: Run tests
         run: >-

.github/workflows/regions.yml

@@ -0,0 +1,48 @@
+name: Check for new regions
+
+on:
+  pull_request:
+    paths: src/region.rs
+  workflow_dispatch:
+  schedule:
+    - cron: >-
+        15 15 * * *
+
+jobs:
+  check:
+    name: Check
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      issues: write
+    steps:
+      - name: Get current regions
+        run: >
+          curl 'https://app.fly.io/graphql' -H 'Accept: application/json' -H 'Content-Type: application/json' --data-binary '{"query":"{\n  platform {\n    regions {\n      code\n      name\n    }\n  }\n}"}'
+          | jq '.data.platform.regions'
+          > "${RUNNER_TEMP}/regions.current.json"
+      - uses: actions/checkout@v4
+      - uses: moonrepo/setup-rust@v1
+      - name: Get defined regions
+        run: >-
+          cargo run --example regions | awk '{print $1}' | sort
+          > "${RUNNER_TEMP}/regions.defined.txt"
+      - name: Compare
+        uses: silverlyra/script-action@v0.2
+        with:
+          script: |
+            const read = (filename) => fs.readFile(path.join(env.RUNNER_TEMP, filename), 'utf-8');
+            const current = JSON.parse(await read('regions.current.json'));
+            const defined = new Set((await read('regions.defined.txt')).split('\n').filter(Boolean));
+            const absent = new Set();
+
+            for (const { code, name } of current) {
+              console.log(`${code}\t${name}`);
+
+              if (!defined.has(code)) {
+                absent.add(code);
+                console.log(`  not defined in Flytrap`);
+              }
+            }
+
+            if (absent.size > 0) process.exit(1);

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "flytrap"
 description = "Query the Fly.io runtime environment"
-version = "0.2.0"
+version = "0.2.1"
 edition = "2021"
 license = "MIT"
 authors = ["Lyra Naeseth <lyra@lyra.codes>"]
@@ -67,6 +67,10 @@ tokio = { version = "1.34.0", features = ["full"] }
 name = "api"
 required-features = ["api", "environment"]
 
+[[example]]
+name = "regions"
+required-features = ["regions"]
+
 [package.metadata.docs.rs]
 all-features = true
 rustdoc-args = ["--cfg", "docsrs"]

examples/regions.rs

@@ -0,0 +1,7 @@
+use flytrap::Region;
+
+fn main() {
+    for (code, details) in Region::all() {
+        println!("{}\t{}", code, details.name);
+    }
+}

src/region.rs

@@ -240,6 +240,11 @@ impl Region {
         DETAILS[*self]
     }
 
+    /// Iterate over all known [regions][Region].
+    pub fn all() -> impl Iterator<Item = (Region, RegionDetails<'static>)> {
+        DETAILS.iter().map(|(r, d)| (r, *d))
+    }
+
     fn key(&self) -> RegionKey<'_> {
         (self.city.geo.x(), self.city.geo.y(), &self.code)
     }
@@ -330,7 +335,7 @@ impl FromStr for Region {
 /// assert_eq!(city.name, "Atlanta");
 /// assert_eq!(name, "Atlanta, Georgia (US)");
 /// ```
-#[derive(Copy, Clone, Debug)]
+#[derive(Copy, Clone, Debug, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 pub struct RegionDetails<'l> {
     pub code: &'l str,
@@ -359,7 +364,7 @@ impl RegionDetails<'static> {
 }
 
 /// Describes a city where a Fly.io [region][Region] is hosted.
-#[derive(Copy, Clone, Debug)]
+#[derive(Copy, Clone, Debug, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 pub struct City<'l> {
     pub name: &'l str,
@@ -597,4 +602,10 @@ mod test {
             regions
         );
     }
+
+    #[test]
+    fn all() {
+        assert!(Region::all().count() >= 30);
+        assert!(Region::all().all(|(r, d)| r.details() == d));
+    }
 }