Get FLEx model version from repo and store in metadata #1082

rmunn · 2024-09-26T09:46:00Z

This PR adds a command to our command runner to extract the FLEx project's model version from the repo and store it in the FlexProjectMetadata table. It also adds a GraphQL mutation to update the model version; that mutation returns the project, so that the frontend calling that mutation can also query flexProjectMetadata { flexModelVersion } as part of the mutation results, and get the updated model version in a single step.

github-actions · 2024-09-26T09:46:47Z

UI unit Tests

12 tests 12 ✅ 0s ⏱️
4 suites 0 💤
1 files 0 ❌

Results for commit 21d089e.

♻️ This comment has been updated with latest results.

github-actions · 2024-09-26T09:48:11Z

C# Unit Tests

71 tests +71 71 ✅ +71 6s ⏱️ +6s
12 suites +12 0 💤 ± 0
1 files + 1 0 ❌ ± 0

Results for commit 21d089e. ± Comparison against base commit 13d70f2.

♻️ This comment has been updated with latest results.

rmunn · 2024-09-26T09:51:31Z

Haven't added any frontend changes yet, because I'm not certain how we actually want to expose this on the project page. That should probably happen before I actually ask for a code review, so let me withdraw my review request and mark this one as draft.

Regular users won't be shown the model version because it's a little too technical, but project managers (and org & site admins) can see it.

rmunn · 2024-09-27T05:09:00Z

backend/LexBoxApi/Services/HgService.cs

+        }
+        catch
+        {
+            if (int.TryParse(text, out var num)) return num;


Fallback in case a future FLEx or Chorus update decides to make this a simple text file containing the number instead of JSON. Probably not needed; can remove if you think I should remove it.

Yeah let's remove it as it's planning for something that might never happen

frontend/src/routes/(authenticated)/project/[project_code]/+page.svelte

rmunn · 2024-09-27T08:15:40Z

Converted to draft because requirements just changed: frontend should now present FW version numbers (e.g. 7000068 is FW 8.2, 7000069 is FW 8.3, and so on). Will implement on Monday.

rmunn · 2024-09-28T04:32:02Z

A list of all unique model versions in all FLEx repos in prod, which took all of 2 minutes 23 seconds to generate (plus a couple more minutes to test the script on staging):

{"modelversion": 7000058}
{"modelversion": 7000059}
{"modelversion": 7000060}
{"modelversion": 7000063}
{"modelversion": 7000064}
{"modelversion": 7000066}
{"modelversion": 7000067}
{"modelversion": 7000068}
{"modelversion": 7000069}
{"modelversion": 7000070}
{"modelversion": 7000072}

So I won't have very many model versions to put in the table. The project counts for each model version:

58 - 1 project
59 - 2 projects
60 - 1 project
63 - 3 projects
64 - 2 projects
66 - 11 projects
67 - 27 projects
68 - 335 projects
69 - 4 projects
70 - 439 projects
72 - 1,289 projects

According to the MasterLCModel.xml file in liblcm, the models have the following dates:

17 January 2018 (7000072)
16 March 2015 (7000071) (NOTE: this was never part of a release)
05 December 2016 (7000070)
08 August 2016 (7000069)
9 July 2013 (7000068)
7 May 2013 (7000067)
22 March 2013 (7000066)
15 March 2013 (7000065)
15 February 2013 (7000064)
15 October 2012 (7000063)
12 October 2012 (7000062)
13 September 2012 (7000061)
16 August 2012 (7000060)
29 May 2012 (7000059)
25 April 2012 (7000058)

Looking through the Git tags for various FieldWorks releases, I find the following dates:

7.2.3: 16 March 2012 (before 58)
7.2.4: 25 April 2012 (after 58, before 59)
7.2.5: 26 June 0212 (after 59, before 60)
7.2.6: 1 August 2012 (before 60)
7.2.7: 11 October 2012 (after 60, after 61, before 62)
7.3-gial: 27 March 2013 (after 65)
8.0.2: 18 April 2013 (after 66)
8.0.3-beta4: 11 July 2013 (just after 68)
...
8.2.8: 19 May 2016 (before 69)
8.2.9: 18 October 2016 (after 69)
8.3.5-beta: 2 March 2017 (after 70)
8.3.11: 8 December 2017 (after 70, before 72)
9.0.0-alpha1: 9 January 2018 (just before 72)
9.0.1-alpha2: 14 May 2018 (after 72)

So I'm going to use the following model - version number table for display purposes:

58 - FW 7.2
59 - FW 7.2
60 - FW 7.2
61 - FW 7.2
62 - FW 7.3
63 - FW 7.3
64 - FW 7.3
65 - FW 7.3
66 - FW 8.0
67 - FW 8.0
68 - FW 8.0-8.2
69 - FW 8.2
70 - FW 8.3
71 - FW 8.3 (never released, but why not have it in the table?)
72 - FW 9

And show it to everyone instead of just managers.

hahn-kev

Reviewed, turns out I forgot some older review comments, sorry they didn't get submitted.

hahn-kev · 2024-09-27T06:14:47Z

backend/LexBoxApi/GraphQL/ProjectMutations.cs

+        var projectId = await projectService.LookupProjectId(code);
+        await permissionService.AssertCanManageProject(projectId);
+        var project = await dbContext.Projects.FindAsync(projectId);
+        NotFoundException.ThrowIfNull(project);


I don't think this is needed as we already know the project exists because we were able to find a project ID from the code. Which means we can skip the project query entirely

hahn-kev · 2024-09-27T06:16:10Z

backend/LexBoxApi/Services/HgService.cs

+        }
+        catch
+        {
+            if (int.TryParse(text, out var num)) return num;


Yeah let's remove it as it's planning for something that might never happen

hahn-kev · 2024-10-02T02:23:46Z

frontend/src/lib/components/Projects/FlexModelVersionText.svelte

+  $: fwModel = versionLookupTable[modelVersion] ?? 'Unknown FieldWorks version';
+</script>
+
+<span class={extraClass}>{fwModel}</span>


I would like a tooltip on this to see the modelVersion, just using the title attribute should be fine

hahn-kev · 2024-10-02T02:25:09Z

frontend/src/routes/(authenticated)/project/[project_code]/+page.svelte

@@ -379,6 +389,22 @@
          </AdminContent>
        </DetailItem>
      {/if}
+      <!-- Only show model version to project managers and admins, too technical to show to regular members -->
+      {#if project.type === ProjectType.FlEx}


your comment doesn't match the condition, is this missing or is the comment no longer valid since it's the flex version?

Removed the check, so I should remove the comment.

rmunn requested a review from hahn-kev September 26, 2024 09:46

rmunn self-assigned this Sep 26, 2024

rmunn marked this pull request as draft September 26, 2024 09:51

rmunn removed the request for review from hahn-kev September 26, 2024 09:51

rmunn mentioned this pull request Sep 26, 2024

Actually update language project ID correctly #1083

Merged

rmunn added 3 commits September 27, 2024 11:39

DB migration for FlexModelVersion metadata column

b88aa58

Add API to get FLEx model version from repo

9c276b9

Add GraphQL mutation to update FLEx model version

3b5ee77

rmunn force-pushed the feat/flex-metadata-for-modelversion branch from 7d65f5e to 3b5ee77 Compare September 27, 2024 04:40

Show model version (to managers only) on project page

30c2c20

Regular users won't be shown the model version because it's a little too technical, but project managers (and org & site admins) can see it.

rmunn commented Sep 27, 2024

View reviewed changes

frontend/src/routes/(authenticated)/project/[project_code]/+page.svelte Outdated Show resolved Hide resolved

rmunn marked this pull request as ready for review September 27, 2024 05:11

rmunn requested review from hahn-kev and removed request for hahn-kev September 27, 2024 05:11

rmunn marked this pull request as draft September 27, 2024 08:14

rmunn added 3 commits September 30, 2024 10:17

Show FLEx version instead of model version

d9df3ea

And show it to everyone instead of just managers.

Use single quotes in JS/Svelte files

088fb71

Remove unused import

21d089e

rmunn marked this pull request as ready for review September 30, 2024 04:00

rmunn requested a review from hahn-kev September 30, 2024 04:00

hahn-kev requested changes Oct 2, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Get FLEx model version from repo and store in metadata #1082

Get FLEx model version from repo and store in metadata #1082

rmunn commented Sep 26, 2024 •

edited

Loading

github-actions bot commented Sep 26, 2024 •

edited

Loading

github-actions bot commented Sep 26, 2024 •

edited

Loading

rmunn commented Sep 26, 2024

rmunn Sep 27, 2024

hahn-kev Sep 27, 2024

rmunn commented Sep 27, 2024

rmunn commented Sep 28, 2024

hahn-kev left a comment

hahn-kev Sep 27, 2024

hahn-kev Sep 27, 2024

hahn-kev Oct 2, 2024

hahn-kev Oct 2, 2024

rmunn Oct 11, 2024

Get FLEx model version from repo and store in metadata #1082

Are you sure you want to change the base?

Get FLEx model version from repo and store in metadata #1082

Conversation

rmunn commented Sep 26, 2024 • edited Loading

github-actions bot commented Sep 26, 2024 • edited Loading

UI unit Tests

github-actions bot commented Sep 26, 2024 • edited Loading

C# Unit Tests

rmunn commented Sep 26, 2024

rmunn Sep 27, 2024

Choose a reason for hiding this comment

hahn-kev Sep 27, 2024

Choose a reason for hiding this comment

rmunn commented Sep 27, 2024

rmunn commented Sep 28, 2024

hahn-kev left a comment

Choose a reason for hiding this comment

hahn-kev Sep 27, 2024

Choose a reason for hiding this comment

hahn-kev Sep 27, 2024

Choose a reason for hiding this comment

hahn-kev Oct 2, 2024

Choose a reason for hiding this comment

hahn-kev Oct 2, 2024

Choose a reason for hiding this comment

rmunn Oct 11, 2024

Choose a reason for hiding this comment

rmunn commented Sep 26, 2024 •

edited

Loading

github-actions bot commented Sep 26, 2024 •

edited

Loading

github-actions bot commented Sep 26, 2024 •

edited

Loading