feat(flights): new logic (#31)

Author: TheOutdoorProgrammer

.github/workflows/main.yml

@@ -7,6 +7,10 @@ on:
   pull_request:
     types: [ labeled ]
 
+permissions:
+  id-token: write
+  contents: read
+
 jobs:
 
   push:
@@ -48,38 +52,33 @@ jobs:
         working-directory: terraform
         run: terraform fmt -check
 
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v1
+        with:
+          aws-region: "us-east-1"
+          role-to-assume: ${{ secrets.AWS_ROLE_ARN }}
+          role-session-name: "fly"
+          role-duration-seconds: 900
+
       # Initialize a new or existing Terraform working directory by creating initial files, loading any remote state, downloading modules, etc.
       - name: Terraform Init
         run: terraform init
         working-directory: terraform
-        env:
-          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
-          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
 
       - name: Terraform plan
         run: terraform plan
         working-directory: terraform
-        env:
-          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
-          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
 
         # On push to main, build or change infrastructure according to Terraform configuration files
         # Note: It is recommended to set up a required "strict" status check in your repository for "Terraform Cloud". See the documentation on "strict" required status checks for more information: https://help.github.com/en/github/administering-a-repository/types-of-required-status-checks
       - name: Terraform Apply
         if: startsWith(github.ref, 'refs/tags/')
         working-directory: terraform
         run: terraform apply -auto-approve
-        env:
-          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
-          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
 
       # Create Cloudfront invalidation
       - run: aws cloudfront create-invalidation --distribution-id E1N3PITIUX8V3S --paths "/*"
         if: startsWith(github.ref, 'refs/tags/')
-        env:
-          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
-          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-          AWS_DEFAULT_REGION: "us-east-1"
 
       - name: Create release version string
         if: startsWith(github.ref, 'refs/tags/')

README.MD

@@ -46,24 +46,34 @@ Defaults can be set/unset via:
 - `fly unset {key}`
 
 ### How it works
-Look at the `gh` logical flight as an example. Its logic is as follows: `https://github.com/${gh-org}/${repo}`.
+Look at the `gh` logical flight as an example. Its logic is as follows: `https://github.com/${gh-org:plain}/${repo:plain}`.
 
-If no defaults are specified, the extension will assume you will pass in at least 2 parameters to the flight.  
-`fly gh Apollorion manifests.io` is calculated positionally. `Apollorion` (the first parameter) will replace `${gh-org}` (the first variable)
-and `manifests.io` (the second parameter) will replace `${repo}` (the second variable).
+If no defaults are specified, the extension will assume you will pass in 2 parameters to the flight.  
+`fly gh Apollorion manifests.io` is calculated positionally. `Apollorion` (the first parameter) will replace `${gh-org:plain}` (the first variable)
+and `manifests.io` (the second parameter) will replace `${repo:plain}` (the second variable).
 Which will fly to `https://github.com/Apollorion/manifests.io`.
 
 You can, optionally, set a default for any variable in a logical flight.  
 `fly set gh-org Apollorion` will set the default for `gh-org` to `Apollorion`.
-Now, when you fly the `gh` flight, it will first replace `${gh-org}` with `Apollorion` and then any remaining parameters will be replaced positionally, like above.
+Now, when you fly the `gh` flight, it will first replace `${gh-org:plain}` with `Apollorion` and then any remaining parameters will be replaced positionally, like above.
 So you could do `fly gh manifests.io` and it will fly to `https://github.com/Apollorion/manifests.io`.
 
 Note: ANY unset parameters will be replaced positionally, in order.  
-If you have a logical flight that is defined as `https://my.com/{$thing1}/{$thing2}/{$thing3}`, and you only set the default for `thing1`.
+If you have a logical flight that is defined as `https://my.com/${thing1:plain}/${thing2:plain}/${thing3:plain}`, and you only set the default for `thing1`.
 The extension will expect you to pass in 2 parameters at flight time, otherwise a default flight will be used or an error will be thrown.  
 `fly my.com test1 test2` will fly to `https://my.com/{thing1 default}/test1/test2/`.  
 `fly my.com test` will either go to a defined default flight or throw an error.
 
+### Types
+Types are useful when you want the application to do something to a string before its passed to the browser.  
+`plain` will pass the value as plain text (I.E. it will do nothing)  
+`urlencode` will url encode the value
+
+An example of this would be the built in `ghcs` flight. When searching github code search, the values need to be url encoded. 
+So when you query ghcs the user can pass in plain text, but it will be url encoded for the browser.
+
+Currently, only `plain` and `urlencode` are supported. All variables must have a type defined.
+
 # Custom flight repos
 You can host a custom flight repo and point the extension to it. This will allow you to define standard and logical flights without contributing to this project.
 
@@ -77,10 +87,10 @@ The custom flight repo has 2 requirements.
 2. It has the below structure:
 ```typescript
 interface CustomFlightRepo {
-    version: string, // Currently supported version is `1`
+    version: string, // Currently supported version is `2`
     logical: {
         [key: string]: {
-            logic: string,
+            logic: string[],
             override?: string
         }
     },
@@ -89,13 +99,21 @@ interface CustomFlightRepo {
     }
 }
 ```
-An example repo doc is here: `https://apollorion.com/flight_repo_named.json`
+An example repo doc is here: `https://raw.githubusercontent.com/Apollorion/fly/main/help/example-repo.json`
 
 ex:
-1. `fly repo set apollorion https://apollorion.com/flight_repo_named.json`
+1. `fly repo set apollorion https://raw.githubusercontent.com/Apollorion/fly/main/help/example-repo.json`
 2. `fly repo update`
 3. `fly repo unset apollorion`
 
+## Custom flight logic evaluation
+Custom flights are a list of strings that are evaluated first come, first served, the extension will evaluate the first logic and if its not suitable it will move to the next.
+A suitable flight is defined as; when the number of parameters passed in by the user is 0 and there are no variables left in the logic.
+
+The only exception to this rule is if the last variable in the last defined flight logic has the type `urlencode`, its the only parameter, and no other matches were found.
+In this case, the application will url encode all the parameters together and take that flight. You can see this in action with the built in `ghcs` flight. 
+As long as you pass at least 3 or more parameters to that flight, it will urlencode them together.
+
 Note: Logical flights take precedence over standard flights, in a custom flight repo. If a flight is defined in this extension as a logical flight, and you want to simplify it, you will want to
 define it as a logical flight in your repo. Otherwise, your flight will not work.
 

extension/flights.ts

@@ -3,21 +3,29 @@ import {LogicalFlightDefinition, StandardFlightDefinition} from "./types.js";
 export const logicalFlights: LogicalFlightDefinition = {
     "aws": {
         "override": "https://console.aws.amazon.com/console/home",
-        "logic": "https://console.aws.amazon.com/console/home?region=${region}",
+        "logic": ["https://console.aws.amazon.com/console/home?region=${region:plain}"],
     },
     "gh": {
-        "logic": "https://github.com/${gh-org}/${repo}",
+        "logic": ["https://github.com/${gh-org:plain}/${repo:plain}"],
+    },
+    "ghcs": {
+        "logic": [
+            "https://cs.github.com/?scopeName=All+repos&scope=&q=org%3A${ghcs-org:plain}+${ghcs-query:urlencode}",
+            "https://cs.github.com/?scopeName=All+repos&scope=&q=${ghcs-query:urlencode}",
+        ],
     },
     "tfc": {
         "override": "https://app.terraform.io/app/",
-        "logic": "https://app.terraform.io/app/${tfc-org}/workspaces?search=${tfc-search}"
+        "logic": ["https://app.terraform.io/app/${tfc-org:plain}/workspaces?search=${tfc-search:plain}"]
+    },
+    "dd": {
+        "override": "https://app.datadoghq.com/",
+        "logic": ["https://app.datadoghq.com/${dd-product:plain}"]
     }
 };
 
 export const standardFlights: StandardFlightDefinition = {
-    "https://app.datadoghq.com/" : ["datadog", "dd"],
-
-    "https://github.com/Apollorion/fly/blob/main/help/config-github.md#org-not-set" : ["config-github/org-not-set"],
-    "https://github.com/Apollorion/fly/blob/main/help/config-github.md#repo-not-set" : ["config-github/repo-not-set"],
-    "https://github.com/Apollorion/fly/blob/main/help/logical-flights.md#logic-not-found" : ["logical-flights/not-found"]
+    // This standard flight is included for testing purposes
+    // normally it would be easier to just use the omnibar for google searches
+    "https://google.com/": ["google", "go"]
 }

extension/helpers.test.ts

@@ -1,11 +1,15 @@
 import { repoManagement } from './helpers';
 import {setLocalStorage, getLocalStorage} from "./localstorage.js";
 
-function mockGetLocalStorageWithResult() {
+function mockGetLocalStorageWithResult(type: string) {
     // @ts-ignore
     getLocalStorage = jest.fn(async (key) => {
         return new Promise((resolve, reject) => {
-            resolve("{}");
+            if(type === "good"){
+                resolve("{}");
+            } else {
+                resolve("{\"apollorion\": \"https://apollorion.com/flight_repo.json\"}");
+            }
         });
     });
 }
@@ -25,29 +29,39 @@ function mockSetLocalStorage() {
 }
 
 test("repo can set", async () => {
-    mockGetLocalStorageWithResult();
+    mockGetLocalStorageWithResult("good");
     mockSetLocalStorage();
 
     const result = await repoManagement(["repo", "set", "apollorion", "https://apollorion.com/flight_repo.json"]);
     expect(result).toBe("set apollorion https://apollorion.com/flight_repo.json");
 });
 
 test("repo can unset", async () => {
-    mockGetLocalStorageWithResult();
+    mockGetLocalStorageWithResult("good");
     mockSetLocalStorage();
 
     const result = await repoManagement(["repo", "unset", "apollorion"]);
     expect(result).toBe("unset apollorion");
 });
 
 test("repo can update", async () => {
-    mockGetLocalStorageWithResult();
+    mockGetLocalStorageWithResult("good");
     mockSetLocalStorage();
 
     const result = await repoManagement(["repo", "update"]);
     expect(result).toBe("repos updated");
 });
 
+test("repo cannot update", async () => {
+    mockGetLocalStorageWithResult("bad");
+    mockSetLocalStorage();
+    console.log = jest.fn();
+
+    const result = await repoManagement(["repo", "update"]);
+    expect(result).toBe("repos updated");
+    expect(console.log).toHaveBeenCalledWith('Failed to fetch repo apollorion');
+});
+
 test("repo set no local storage", async () => {
     mockGetLocalStorageWithoutResult();
     mockSetLocalStorage();

extension/helpers.ts

@@ -1,23 +1,24 @@
-import {Flight, FlightType, LogicalFlightDefinition, StandardFlightDefinition, RepoFlightsResponse} from "./types.js";
+import {Flight, FlightType, FlightPlans} from "./types.js";
 import {logicalFlights, standardFlights} from "./flights.js";
 import {setLocalStorage, getLocalStorage, unsetLocalStorage} from "./localstorage.js";
 
-export async function getFlightFromQuery(query: string[], repoFlightResponse: RepoFlightsResponse | undefined): Promise<Flight> {
+const supportedCustomFlightVersion = "2";
+
+export async function getFlightFromQuery(query: string[], flightPlans: FlightPlans): Promise<Flight> {
     // Remove null items from values
     query = query.filter(function (el) {
         return el != null;
     });
 
-    const newFlights = getNewFlightResponseSynchronous(repoFlightResponse);
-    const newLogicalFlights = newFlights.logical;
+    const logicalFlightPlans = flightPlans.logical;
 
-    if(query[0] in newLogicalFlights){
+    if(query[0] in logicalFlightPlans){
         const identifier = query[0];
         query.shift();
 
         let d = undefined;
-        if(newLogicalFlights[identifier].override !== undefined){
-            d = newLogicalFlights[identifier].override;
+        if(logicalFlightPlans[identifier].override !== undefined){
+            d = logicalFlightPlans[identifier].override;
         }
 
         return {
@@ -34,45 +35,33 @@ export async function getFlightFromQuery(query: string[], repoFlightResponse: Re
     }
 }
 
-export function getNewFlightResponseSynchronous(repoFlightResponse: RepoFlightsResponse | undefined) : RepoFlightsResponse{
-    let newLogicalFlights: LogicalFlightDefinition;
-    if(repoFlightResponse !== undefined) {
-        newLogicalFlights = {
-            ...logicalFlights,
-            ...repoFlightResponse.logical
-        }
-    } else {
-        newLogicalFlights = {
-            ...logicalFlights
-        }
+export async function getFlightPlans(): Promise<FlightPlans>{
+    let localFlights = undefined;
+    try {
+        const jsonString = await getLocalStorage("updated-repos");
+        localFlights = JSON.parse(jsonString);
+    } catch (e) {
+        console.log("No custom repo set", e);
     }
 
-    let newStandardFlights: StandardFlightDefinition;
-    if(repoFlightResponse !== undefined) {
-        newStandardFlights = {
-            ...standardFlights,
-            ...repoFlightResponse.standard
-        }
-    } else {
-        newStandardFlights = {
-            ...standardFlights
+    if(localFlights === undefined){
+        return {
+            logical: logicalFlights,
+            standard: standardFlights
         }
     }
 
-    return {
-        logical: newLogicalFlights,
-        standard: newStandardFlights
+    if(localFlights.version !== supportedCustomFlightVersion){
+        console.log("Unsupported local flight version");
+        return {
+            logical: logicalFlights,
+            standard: standardFlights
+        }
     }
 
-}
-
-export async function checkRepoFlights(): Promise<RepoFlightsResponse | undefined>{
-    try {
-        const jsonString = await getLocalStorage("updated-repos");
-        return JSON.parse(jsonString);
-    } catch (e) {
-        console.log("No custom repo set", e);
-        return undefined;
+    return {
+        logical: { ...logicalFlights, ...localFlights.logical },
+        standard: { ...standardFlights, ...localFlights.standard }
     }
 }
 
@@ -127,16 +116,18 @@ export async function repoManagement(query: string[]): Promise<string> {
         case "update":
             try {
                 repoResult = await getLocalStorage("repos");
+                console.log(repoResult);
             } catch {
                 repoResult = "{}";
             }
             repos = JSON.parse(repoResult);
 
-            let newRepoContent = {standard: {}, logical: {}};
+            let newRepoContent = {standard: {}, logical: {}, version: supportedCustomFlightVersion};
             for(let name in repos){
                 try {
                     let json = JSON.parse(await requestJson(repos[name]));
-                    if(json.version === "1" && Object.keys(json).includes("logical") && Object.keys(json).includes("standard")){
+                    if(Object.keys(json).includes("version") && json.version === supportedCustomFlightVersion
+                        && Object.keys(json).includes("logical") && Object.keys(json).includes("standard")){
                         newRepoContent.standard = {...newRepoContent.standard, ...json.standard};
                         newRepoContent.logical = {...newRepoContent.logical, ...json.logical};
                     }
@@ -151,6 +142,24 @@ export async function repoManagement(query: string[]): Promise<string> {
     }
 }
 
+export function makeType(value: string, type: string): string {
+    switch(type){
+        case "plain":
+            return value;
+        case "urlencode":
+            return encodeURIComponent(value);
+        default:
+            throw new Error("Type not found");
+    }
+}
+
+export function getType(value: string): string {
+    return value.replace("}", "").split(":")[1]
+}
+
+export function getValue(value: string): string {
+    return value.replace("${", "").split(":")[0]
+}
 
 export async function setCalled(query: string[]){
     if(query.length === 3){