feat(OY2-26538): package action changelog #290

pkim-gswell · 2024-01-02T17:47:42Z

Purpose

There are many changes in this PR. The primary change is a suggestive reorganizing of our types structure. With the new addition of opensearch changelog index, a couple pain-points came to light. First, there's a tight coupling between the core type structures and the main index. Second, a lack of division between domains has led to an inconsistent and hard-to-establish naming convention with unwieldy imports:

import type {
  OsQueryState,
  OsFilterable,
  OsAggQuery,
  OsMainSearchResponse,
} from "shared-types";

type Props = {
  filters: OsFilterable[]
  sort?: OsQueryState["sort"];
  pagination: OsQueryState["pagination"];
  aggs?: OsAggQuery[];
  data: OsMainSearchResponse
}

"All to say"

The new proposed structure cuts down on imports by taking advantage of namespaces:

import { opensearch } from "shared-types";

type Props = {
  filters: opensearch.Filterable[]
  sort?: opensearch.QueryState["sort"];
  pagination: opensearch.QueryState["pagination"];
  aggs?: opensearch.Agg["query"];
  data: opensearch.main.Response
};

In addition, the api integration of the aforementioned changelog index has been implemented.

There are 2 ways to access a package's changelog:

using the useChangelogSearch hook

const { mutateAsync } = useChangelogSearch();

await mutateAsync({
  index: "changelog",
  pagination: { number: 0, size: 200 },
  filters: [
    {
      field: "packageId.keyword",
      type: "term",
      value: "CO-2444-23",
      prefix: "must",
    },
  ],
});

using the useGetItem hook

const { data: item } = useGetItem(id!);

Linked Issues to Close

https://qmacbis.atlassian.net/browse/OY2-26538

Approach

Assorted Notes/Considerations/Learning

List any other information that you think is important... a post-merge activity, someone to notify, what you learned, etc.

… into bruce

pkim-gswell · 2024-01-05T13:35:17Z

src/packages/shared-types/opensearch/index.ts

+export * as changelog from "./changelog";
+export * as main from "./main";
+export * from "./_";


This is where namespaces get defined

pkim-gswell · 2024-01-05T13:35:40Z

src/packages/shared-types/index.ts

@@ -4,7 +4,7 @@ export * from "./errors";
 export * from "./seatool";
 export * from "./onemac";
 export * from "./onemacLegacy";
-export * from "./opensearch";
+export * as opensearch from "./opensearch";


This creates the overarching opensearch namespace

pkim-gswell · 2024-01-05T13:36:47Z

src/packages/shared-types/opensearch/_.ts

@@ -0,0 +1,82 @@
+export type Hit<T> = {


here are the opensearch core type definitions

I like it. Any reason why the filename is _?

Initially named it base.ts. But I figured that was too based.

pkim-gswell · 2024-01-05T13:38:31Z

src/packages/shared-types/opensearch/changelog.ts

+export type Response = Res<Document>;
+export type ItemResult = Hit<Document> & {
+  found: boolean;
+};
+
+export type Field = keyof Document | `${keyof Document}.keyword`;
+export type Filterable = FIL<Field>;
+export type State = QueryState<Field>;
+export type Aggs = AggQuery<Field>;


Both main and changelog Indices enforce the same naming convention

pkim-gswell · 2024-01-05T13:40:05Z

src/services/api/libs/package/getPackage.ts

+    from: 0,
+    size: 200,
+    // NOTE: get the required timestamp sort field
+    sort: [{}],


@mdial89f

Still need to flesh out the timestamp/dates

pkim-gswell · 2024-01-05T13:41:16Z

src/services/ui/src/pages/detail/package-activity/index.tsx

+  "respond-to-rai",
+];
+
+export const PackageActivities: FC<opensearch.main.Document> = (props) => {


Entry point for PackageActivity section

pkim-gswell · 2024-01-05T13:41:33Z

src/services/ui/src/pages/detail/admin-changes/index.tsx

+
+export const ACTIONS_ADMIN = ["disable-rai-withdraw", "enable-rai-withdraw"];
+
+export const AdminChanges: FC<opensearch.main.Document> = (props) => {


Entry point for AdminChanges section

pkim-gswell · 2024-01-05T13:51:41Z

@mdial89f @13bfrancis @kevinhaube

Here are the remaining todos:

download all export feature
what are the correct timestamps/dates?
nail down the correct actions for each section

Since other tickets are blocked by this package changelog PR. I think we should move forward the merge (barring no breaking changes), and document remaining todos onto the Jira ticket.

… into bruce

hannasage

Most my questions are pattern-based so they're universal across AC and PA code

hannasage · 2024-01-09T17:17:53Z

src/services/api/serverless.yml

@@ -107,7 +107,7 @@ functions:
      osDomain: ${param:osDomain}
    events:
      - http:
-          path: /search
+          path: /search/{index}


🔥 Love that we're keeping the endpoint dynamic params pattern from Actions. Keeps endpoints uniform!

hannasage · 2024-01-09T17:22:15Z

src/services/api/libs/package/getPackage.ts

+
+  return {
+    ...main,
+    _source: { ...main._source, changelog: changelog.hits.hits },


Wondering if we should bundle them here or break them out as individual getters. With React components, we can easily load "per-component" rather than piping a top-level object thru to sub-components.

A quick cost-benefit analysis doesn't really raise any immediate needs tho. Just starting the convo!

I see your point. I've pulled out the changelog getter into a separate file and moved data aggregation to the handler 👍

hannasage · 2024-01-09T17:26:45Z

src/services/ui/src/pages/detail/admin-changes/AdminChanges.tsx

+      case "update":
+        return ["SPA ID update", AC_Update];


Future stuff? I know OneMAC supports this from the back-end via a lamda, so I figured it was coming soon.

Correct, this will be refined in the future. At the moment, we're not 100% sure of the event shape.

hannasage · 2024-01-09T17:29:33Z

src/services/ui/src/pages/detail/admin-changes/AdminChanges.tsx

+  return useMemo(() => {
+    switch (doc.actionType) {
+      case "disable-rai-withdraw":
+        return ["Disabled formal RAI response withdraw", AC_WithdrawDisabled];


I like bundling these, but would a typed response be of any benefit here? I see we're doing an inline type below on line 59.

Added a response type 👍

mdial89f · 2024-01-09T20:27:08Z

src/services/data/handlers/reindex.ts

@@ -133,6 +133,8 @@ export const deleteIndex: Handler = async () => {
      throw "process.env.osDomain cannot be undefined";
    }
    await os.deleteIndex(process.env.osDomain, "main");
+    await os.deleteIndex(process.env.osDomain, "changelog");
+    await os.deleteIndex(process.env.osDomain, "seatool");


mdial89f · 2024-01-09T20:27:14Z

src/services/data/handlers/reindex.ts

@@ -133,6 +133,8 @@ export const deleteIndex: Handler = async () => {
      throw "process.env.osDomain cannot be undefined";
    }
    await os.deleteIndex(process.env.osDomain, "main");
+    await os.deleteIndex(process.env.osDomain, "changelog");


mdial89f · 2024-01-09T20:27:37Z

src/services/data/handlers/index.ts

@@ -53,12 +53,12 @@ async function manageIndex() {
  try {
    await manageIndexResource({
      index: "main",
+      // TODO: remove after rai transform


mdial89f

@pkim-gswell this appears non breaking and i think this sets things up nicely. I agree with the suggestion of moving ahead with the merge. Approved from my chair, I know kevin has outstanding comments that may need addressed.
I'd really like to get rid of the transform logic as a fast follower to this PR, since the existing RAI list component and its underlying data is no longer needed; I can clean that up or assist.

… into bruce

github-actions · 2024-02-15T00:08:44Z

🎉 This PR is included in version 1.5.0-val.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

feat(OY2-26538): init

1fc40a0

pkim-gswell added the Not Ready label Jan 2, 2024

pkim-gswell added 4 commits January 3, 2024 06:41

feat(OY2-26538): init

48c9c23

feat(OY2-26538): package actions init

67c3ac9

Merge branch 'master' of https://github.com/Enterprise-CMCS/macpro-mako…

a084f38

… into bruce

feat(OY2-26538): package actions init

45d1705

pkim-gswell added enhancement and removed Not Ready labels Jan 5, 2024

pkim-gswell self-assigned this Jan 5, 2024

pkim-gswell commented Jan 5, 2024

View reviewed changes

pkim-gswell added 6 commits January 8, 2024 09:45

feat(OY2-26538): package actions init

228972f

feat(OY2-26538): package actions init

64f37c0

Merge branch 'master' of https://github.com/Enterprise-CMCS/macpro-mako…

c283138

… into bruce

feat(OY2-26538): package actions init

049626d

feat(OY2-26538): package actions dl

d1bc518

feat(OY2-26538): package actions dl

ac5e2b9

pkim-gswell added the ready label Jan 9, 2024

hannasage reviewed Jan 9, 2024

View reviewed changes

mdial89f reviewed Jan 9, 2024

View reviewed changes

mdial89f approved these changes Jan 9, 2024

View reviewed changes

pkim-gswell added 5 commits January 9, 2024 14:48

feat(OY2-26538): package actions cleanup

1efde1a

Merge branch 'master' of https://github.com/Enterprise-CMCS/macpro-mako…

ea4f18f

… into bruce

Merge branch 'master' of https://github.com/Enterprise-CMCS/macpro-mako…

bdb7bd5

… into bruce

Merge branch 'master' of https://github.com/Enterprise-CMCS/macpro-mako…

43e0caf

… into bruce

Merge branch 'master' of https://github.com/Enterprise-CMCS/macpro-mako…

6243d62

… into bruce

pkim-gswell merged commit 8c53dd8 into master Jan 10, 2024
15 of 16 checks passed

github-actions bot added the released on @val label Feb 15, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(OY2-26538): package action changelog #290

feat(OY2-26538): package action changelog #290

pkim-gswell commented Jan 2, 2024 •

edited

Loading

pkim-gswell Jan 5, 2024

pkim-gswell Jan 5, 2024

pkim-gswell Jan 5, 2024

13bfrancis Jan 9, 2024

pkim-gswell Jan 9, 2024 •

edited

Loading

pkim-gswell Jan 5, 2024

pkim-gswell Jan 5, 2024

pkim-gswell Jan 5, 2024

pkim-gswell Jan 5, 2024

pkim-gswell commented Jan 5, 2024

hannasage left a comment

hannasage Jan 9, 2024

hannasage Jan 9, 2024

pkim-gswell Jan 9, 2024

hannasage Jan 9, 2024

pkim-gswell Jan 9, 2024

hannasage Jan 9, 2024

pkim-gswell Jan 9, 2024

mdial89f Jan 9, 2024

mdial89f Jan 9, 2024

mdial89f Jan 9, 2024

mdial89f left a comment

github-actions bot commented Feb 15, 2024


		export const ACTIONS_ADMIN = ["disable-rai-withdraw", "enable-rai-withdraw"];

		export const AdminChanges: FC<opensearch.main.Document> = (props) => {

feat(OY2-26538): package action changelog #290

feat(OY2-26538): package action changelog #290

Conversation

pkim-gswell commented Jan 2, 2024 • edited Loading

Purpose

Linked Issues to Close

Approach

Assorted Notes/Considerations/Learning

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pkim-gswell Jan 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pkim-gswell commented Jan 5, 2024

hannasage left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mdial89f left a comment

Choose a reason for hiding this comment

github-actions bot commented Feb 15, 2024

pkim-gswell commented Jan 2, 2024 •

edited

Loading

pkim-gswell Jan 9, 2024 •

edited

Loading