Merge pull request #3546 from msupply-foundation/release-1.7

Release 1.7

Author: Chris-Petty

.github/ISSUE_TEMPLATE/bug_report.md

@@ -12,7 +12,6 @@ assignees: ''
 
 ## Expected behaviour 🤔
 
-
 ## How to Reproduce 🔨
 
 Steps to reproduce the behaviour:
@@ -24,11 +23,9 @@ Steps to reproduce the behaviour:
 
 ## Your environment 🌱
 <!-- e.g. 1.2.3 -->
- - Version: 
- - Platform:
-   - [ ] android (tablet)
-   - [ ] browser (extra points if you tell us which one)
-   - [ ] desktop (windows)
-   - [ ] desktop (macOS)
-   - [ ] server (windows)
- 
+- Version: 
+- mSupply version: 
+<!-- e.g. android, browser (extra points if you tell us which one), desktop (windows), desktop (macOS), server (windows) -->
+- Platform:
+<!-- PostgreSQL or SQLite3 -->
+- Database type: 

.github/ISSUE_TEMPLATE/refactor.md

@@ -0,0 +1,75 @@
+---
+name: Refactor Suggestion
+about: Suggest a refactor
+title: ""
+labels: "refactor, needs triage"
+assignees: ""
+---
+
+## The suggestion
+
+<!-- Provide a clear and concise description of the suggested change E.g. "Add a new helper function to avoid the need to create service providers in test cases", "Upgrade diesel version to allow async database access", "Create a rust macro to automatically map Graphql and Service layer enums". -->
+
+## Example use case
+
+<!-- EXAMPLE:
+We have a lot of enum mapping code that looks like this:
+
+```rust
+impl ActivityLogNodeType {
+    pub fn from_domain(from: &ActivityLogType) -> ActivityLogNodeType {
+        use ActivityLogNodeType as to;
+        use ActivityLogType as from;
+
+        match from {
+            from::UserLoggedIn => to::UserLoggedIn,
+            from::InvoiceCreated => to::InvoiceCreated,
+...
+            from::SensorLocationChanged => to::SensorLocationChanged,
+        }
+    }
+
+```
+
+To avoid needing to update this every time we add a new variant to the `ActivityLogType` enum, we could create a macro that automatically maps the variants of the `ActivityLogType` enum to the variants of the `ActivityLogNodeType` enum. This would allow us to write the above code like this:
+
+```rust
+impl ActivityLogNodeType {
+    map_std_enum!(ActivityLogType, ActivityLogNodeType);
+}
+```
+-->
+
+### Why should we invest time in this?
+
+<!-- Describe the benefits of this change.
+Examples:
+"This makes it faster and less annoying to add new activity log types, which is a common activity, I estimate that this will save us 1 hour per month."
+"This change makes the code easier to test, reducing the risk of introducing bugs in the future."
+"This change will make it easier for new developers to understand the codebase, reducing the time it takes to onboard new developers."
+"Code will run faster, reducing the time it takes to run our test suite."
+-->
+
+### Are there any risks associated with this change?
+
+<!-- highlight any risks the code changes might introduce
+Examples:
+"The change would involve rewriting our login infrastructure, we'll need extra testing around the login process, and review all our permission mappings"
+"This change is low risk, as we expect it's functionality to be covered by existing tests and these tests don't need to change"
+"This change might impact frontend code that won't be covered by our existing tests, we'll need to do a full regression test with QA team"
+"Introducing async database access might uncover new race conditions or bugs that our test cases don't currently cover"
+-->
+
+### How much effort is required?
+
+<!-- Estimate the amount of effort required to implement this change -->
+<!--
+Examples:
+"This change is trivial, it will take less than 1 hour to implement."
+"This change is a lot of work potentially weeks of effort, however it will reduce the overall time needed to implement our current task, and will make future tasks easier."
+"This change is a lot of work potentially weeks of effort, however once the pattern is established, we can do the refactor piece by piece as we have time available."
+-->
+
+### Agreed Solution
+
+<!-- Describe how you expect to do the refactor, this might be updated as the team discusses the approach more fully -->

.github/workflows/pr-issue-label-sync.yaml

@@ -0,0 +1,126 @@
+name: Sync labels from linked issue to PR
+on:
+  pull_request_target:
+    types: [opened, reopened, edited]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Sync labels
+        uses: actions/github-script@v7
+        with:
+          script: |
+            core.debug(`where the PR? ${context.repo.repo} ${context.repo.owner} ${context.issue.number}`);
+            let x = 1
+            const pullRequestResult = await github.graphql(`
+              query($owner: String!, $repo: String!, $number: Int!) {
+                repository(name: $repo, owner: $owner) {
+                  pullRequest(number: $number) {
+                    id
+                    body
+                    labels (first: 100){
+                      nodes {
+                        id
+                      }
+                    }
+                    closingIssuesReferences(first: 1) {
+                      nodes {
+                        labels(first: 100) {
+                          nodes {
+                            id
+                          }
+                        }
+                        milestone {
+                          id
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            `, {
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              number: context.issue.number
+            })
+
+            core.debug(pullRequestResult)
+
+            const pullRequest = pullRequestResult.repository.pullRequest
+
+            let issue = pullRequest.closingIssuesReferences.nodes[0]
+
+            if (!issue) {
+              const regex = new RegExp(/#(\d+)/);
+              const issueNumber = Number(pullRequest.body.match(regex)[1])
+
+              if  (!issueNumber) {
+                throw new Error('No associated issue found for this pull request. Not even in the body!')
+              }
+
+              const issueResult = await github.graphql(`
+                query ($repo: String!, $owner: String!, $number: Int!) {
+                  repository(name: $repo, owner: $owner) {
+                    issue(number: $number) {
+                      labels(first: 100) {
+                        nodes {
+                          id
+                        }
+                      }
+                      milestone {
+                        id
+                      }
+                    }
+                  }
+                }
+              `, {
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                number: issueNumber
+              })
+
+              core.debug(issueResult)
+              issue = issueResult.repository.issue
+
+              if (!issue) {
+                throw new Error('No associated issue found for this pull request. There was a match in the description, but not to an issue: ${issueNumber}')
+              }
+            }
+
+            core.debug(issue)
+
+            core.debug(x++)
+            const pullRequestId = pullRequest.id
+            core.debug(x++)
+            const pullRequestLabelIds = pullRequest.labels.nodes.map(label => label.id)
+            core.debug(x++)
+            const issueLabelIds = issue.labels.nodes.map(label => label.id)
+            core.debug(x++)
+            const labelIds = issueLabelIds.concat(pullRequestLabelIds)
+            core.debug(x++)
+            const milestoneId = issue.milestone && issue.milestone.id // Linked issue might not have a milestone
+            core.debug(x++)
+
+            const mutationResult = await github.graphql(`
+              mutation($labelIds: [ID!] = "", $pullRequestId: ID!, $milestoneId: ID = "") {
+                updatePullRequest(
+                  input: {pullRequestId: $pullRequestId, labelIds: $labelIds, milestoneId: $milestoneId}
+                ) {
+                  clientMutationId
+                  # pullRequest {
+                  #   labels(first: 100) {
+                  #     nodes {
+                  #       name
+                  #     }
+                  #   }
+                  #   milestone {
+                  #     title
+                  #   }
+                  # }
+                }
+              }
+            `, {
+              pullRequestId,
+              labelIds,
+              milestoneId
+            })

client/README.md

@@ -22,7 +22,7 @@ To see it in action, check out the [demo server](https://demo-open.msupply.org/)
 
 `yarn start` (using demo server as API)
 
-`yarn start-local` (using localhost:8000 as API)
+`yarn start-local` (using localhost:8000 as API - ensure you have already gone through the `server` setup instructions)
 
 `cd packages/host && yarn start -- --env API_HOST='http://localhost:8001'` (using custom API url, see [config.ts for more info](./packages/config/src/config.ts))
 

client/codegen.yml

@@ -1,5 +1,5 @@
 overwrite: true
-schema: [ '../server/schema.graphql' ]
+schema: ['../server/schema.graphql']
 generates:
   ./packages/common/src/types/schema.ts:
     plugins:

client/package.json

@@ -20,7 +20,9 @@
     "test": "jest --config ./jest.config.js --maxWorkers=50% --env=jsdom",
     "storybook": "storybook dev -p 6006",
     "build-storybook": "storybook build",
-    "generate": "cd ../server && cargo run --bin remote_server_cli -- export-graphql-schema && cd ../client && graphql-codegen --config codegen.yml",
+    "gql-codegen": "graphql-codegen --config codegen.yml",
+    "//": "This command runs graphql-codegen twice, as running once is causing import path errors for shared fragments in the generated files (but running twice resolves them??) See issue here: https://github.com/msupply-foundation/open-msupply/issues/2812",
+    "generate": "cd ../server && cargo run --bin remote_server_cli -- export-graphql-schema && cd ../client && yarn gql-codegen && yarn gql-codegen",
     "android:run": "npx cap run android",
     "android:build:server": "yarn build && lerna run --scope @openmsupply-client/android build:server --stream",
     "android:build:debug": "yarn build && lerna run --scope @openmsupply-client/android build:debug --stream",
@@ -82,8 +84,8 @@
     "eslint-config-prettier": "^8.9.0",
     "eslint-plugin-jest-dom": "^5.0.1",
     "eslint-plugin-react": "^7.27.1",
-    "eslint-plugin-storybook": "^0.6.11",
     "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-storybook": "^0.6.11",
     "husky": "^8.0.3",
     "i18n-unused": "^0.13.0",
     "jest": "^29.6.2",

client/packages/android/app/src/main/java/org/openmsupply/client/FileManager.java

@@ -7,18 +7,39 @@
 import android.widget.Toast;
 
 import java.io.BufferedWriter;
+import java.io.InputStream;
+import java.io.IOException;
 import java.io.OutputStream;
+import java.io.BufferedOutputStream;
 import java.io.OutputStreamWriter;
+import java.io.File;
+import java.io.FileInputStream;
+import java.util.zip.ZipEntry;
+import java.util.zip.ZipOutputStream;
 
 public class FileManager {
     private static final int SAVE_FILE_REQUEST = 12321;
+    private static final int SAVE_DATABASE_REQUEST = 12322;
     private Activity activity;
     private String content;
+    private File dbFile;
 
     public FileManager(Activity activity) {
         this.activity = activity;
     }
 
+    public void SaveDatabase(File file) {
+        Intent intent = new Intent(Intent.ACTION_CREATE_DOCUMENT);
+        intent.addCategory(Intent.CATEGORY_OPENABLE);
+        intent.setType("application/zip");
+        intent.putExtra(Intent.EXTRA_TITLE, "openmsupply.sqlite.zip");
+
+        this.dbFile = file;
+
+        activity.startActivityForResult(intent, SAVE_DATABASE_REQUEST);
+
+    }
+
     public void Save(String filename, String content) {
         Intent intent = new Intent(Intent.ACTION_CREATE_DOCUMENT);
         intent.addCategory(Intent.CATEGORY_OPENABLE);
@@ -47,5 +68,60 @@ public void onActivityResult(int requestCode, int resultCode, Intent data) {
                 Toast.makeText(context, "Error: " + e.getMessage(), Toast.LENGTH_LONG).show();
             }
         }
+
+        if (requestCode == SAVE_DATABASE_REQUEST && resultCode == Activity.RESULT_OK && data != null
+                && dbFile != null) {
+            Uri uri = data.getData();
+            Context context = activity.getApplicationContext();
+
+            // The db file name can be either `omsupply-database` or
+            // `omsupply-database.sqlite`
+            // The rust code automatically appends .sqlite to the file name if it doesn't
+            // already exist but uses the old file name it is is still present.
+            // We need to repeat the same logic here for older databases that don't have the
+            // .sqlite extension
+
+            if (!dbFile.isFile()) {
+                dbFile = new File(dbFile + ".sqlite");
+            }
+
+            InputStream inputStream = null;
+            OutputStream outputStream = null;
+            ZipOutputStream zipStream = null;
+
+            try {
+                inputStream = new FileInputStream(dbFile);
+                outputStream = context.getContentResolver().openOutputStream(uri);
+                zipStream = new ZipOutputStream(outputStream);
+
+                ZipEntry entry = new ZipEntry("omsupply-database.sqlite");
+                zipStream.putNextEntry(entry);
+                byte[] buffer = new byte[1024];
+                int length;
+                while ((length = inputStream.read(buffer)) >= 0) {
+                    zipStream.write(buffer, 0, length);
+                }
+
+            } catch (Exception e) {
+                Toast.makeText(context, "Error: " + e.getMessage(), Toast.LENGTH_LONG).show();
+            } finally {
+                if (inputStream != null) {
+                    try {
+                        inputStream.close();
+                    } catch (IOException e) {
+                        e.printStackTrace();
+                    }
+                }
+                if (zipStream != null) {
+                    try {
+                        zipStream.flush();
+                        zipStream.close();
+                    } catch (IOException e) {
+                        e.printStackTrace();
+                    }
+                }
+
+            }
+        }
     }
 }

client/packages/android/app/src/main/java/org/openmsupply/client/MainActivity.java

@@ -3,6 +3,7 @@
 import android.content.Intent;
 import android.os.Bundle;
 import com.getcapacitor.BridgeActivity;
+import java.io.File;
 
 public class MainActivity extends BridgeActivity {
     RemoteServer server = new RemoteServer();
@@ -40,4 +41,8 @@ protected void onActivityResult(int requestCode, int resultCode, Intent data) {
     public void SaveFile(String filename, String content) {
         fileManager.Save(filename, content);
     }
+
+    public void SaveDatabase(File file) {
+        fileManager.SaveDatabase(file);
+    }
 }