Eas 1893 #27

aliner-wang · 2023-09-18T14:30:29Z

into_analyzable_function method for review. working on main.rs.

…nned. And updated alternate_functions to track using entrypoints struct. Todo: capture additional entrypoints for user invokable functions(like macros), write tests + debug, and change main.rs to work with new data struct

…Adding more modules. Writing tests next?

…nfig and export

… in main.rs and test into_analyzble_function use case in main.rs

atlassian-cla-bot · 2023-09-18T14:30:32Z

Thank you for your submission! Like many open source projects, we ask that you sign our CLA (Contributor License Agreement) before we can accept your contribution.
If your email is listed below, please ensure that you sign the CLA with the same email address.

The following users still need to sign our CLA:
❌[email protected]

_{Already signed the CLA? To re-check, try refreshing the page.}

…r for scanning.

…ent {function: str} entry points. Added missing entrypoints on jira:customField and implmented scanning for those

jwong101 · 2023-09-18T16:48:57Z

crates/forge_loader/src/manifest.rs

+// Struct for Custom field Module. Check that search suggestion gets read in correctly. 
+#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
+pub struct CustomField<'a> {
+    #[serde(flatten, borrow)]


These attributes are unnecessary, since serde automatically borrows from &str.

jwong101 · 2023-09-18T16:51:48Z

crates/forge_loader/src/manifest.rs

+    search_suggestion: &'a str,
+    function: &'a str,
+    edit: &'a str,
+    resolver: ModInfo<'a>


Suggested change

resolver: ModInfo<'a>

#[serde(flatten, borrow)]

resolver: Option<ModInfo<'a>>

jwong101 · 2023-09-18T16:53:05Z

crates/forge_loader/src/manifest.rs

+    #[serde(flatten, borrow)]
+    key: &'a str,
+    // all attributes below involve function calls
+    value: &'a str,


I believe these should all be wrapped in Options, since they aren't required properties in the schema.

how do you know whether a property is optional or not?

scratch that I can read

I've updated this struct to:

#[derive(Debug, Clone, PartialEq, Eq, Deserialize)] pub struct CustomField<'a> { #[serde(flatten, borrow)] key: &'a str, // all attributes below involve function calls value: Option<&'a str>, search_suggestions: &'a str, function: Option<&'a str>, edit: Option<&'a str>, resolver: Option<ModInfo<'a>>, }

I think only search_suggestions is the required function attribute cuz it requires a function or an expression? Does that count as required?

No it's not required as per https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/#properties.

jwong101 · 2023-09-18T16:53:29Z

crates/forge_loader/src/manifest.rs

+
+#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
+pub struct WorkflowPostFunction<'a> {
+    #[serde(flatten, borrow)]


These attributes are unnecessary.

Just the serde attributes right?

jwong101 · 2023-09-18T16:53:48Z

crates/forge_loader/src/manifest.rs

 #[derive(Debug, Clone, PartialEq, Eq)]
 pub enum FunctionTy<T> {
    Invokable(T),
    WebTrigger(T),
 }

+// Struct used for tracking what scan a funtion requires.
+#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
+pub struct Entrypoints<'a> {


Suggested change

pub struct Entrypoints<'a> {

pub struct Entrypoint<'a> {

Also, this doesn't need to derive Deserialize.

jwong101 · 2023-09-18T21:07:09Z

crates/forge_loader/src/manifest.rs

+#[derive(Default, Debug, Clone, PartialEq, Eq, Deserialize)]
+struct MacroMod<'a> { 
+    key: &'a str,
+    function: &'a str,


Suggested change

function: &'a str,

#[serde(borrow)]

function: Option<&'a str>,

The function property is optional, since they can just expose the Macro's main entrypoint through a resolver: https://developer.atlassian.com/platform/forge/manifest-reference/modules/macro/#properties.

jwong101 · 2023-09-18T21:15:30Z

crates/forge_loader/src/manifest.rs

+        // self.webtriggers
+        //     .sort_unstable_by_key(|trigger| trigger.function);
+
+        // Get all the Triggers and represent them as a new struct thing where "webtrigger" attribute is true 


This will create a lot of duplicate functions for the downstream analyzers to consume. It might be better to have a BTreeSet or a sorted Vec containing function names that are on user invokable modules. After you create it, iterate through all the functions appearing on the functions property and toggle the invokable flag if it appears in the set of invokable functions. Afterwards, toggle the web_trigger property if it appears as a webtrigger.

jwong101 · 2023-09-18T21:28:03Z

crates/forge_loader/src/manifest.rs

 #[derive(Default, Debug, Clone, PartialEq, Eq, Deserialize)]
 struct ModInfo<'a> {
+    function: &'a str,
+}
+


If you notice, a lot of modules basically contain at least these three properties: key, function, resolver.function, where the function and resolver properties are optional. You could factor this into a common struct like so:

#[derive(Default, Debug, Clone, PartialEq, Eq, Deserialize)] struct CommonKeys<'a> { key: &'a str, #[serde(borrow)] function: Option<&'a str>, #[serde(borrow)] resolver: Option<ModInfo<'a>>, }

and then embed it into the other structs like so:

#[derive(Default, Debug, Clone, PartialEq, Eq, Deserialize)] struct MacroMod<'a> { #[serde(flatten, borrow)] common_keys: CommonKeys<'a>, ... other keys here }

This makes sense to me to simplify the implementation, but how would rust know the mapping? To me, setting common_keys looks like setting a struct within a struct. And keys, function, and resolver would be the first level of the struct.

The serde(flatten) attribute will basically just treat the struct's keys as being embedded in the parent struct. See https://serde.rs/attr-flatten.html for more details.

…d with optional values

…on, and resolver for less code duplication. Updated into_analayzable method to update values based on functions specified in function mod. TODO: Update rest of non trigger modules to update mapping to functions to scan from function mod

…point struct when needed. TODO: test and toggle function call in main.rs

…in.rs

…s for imports using require

… are scanning for

…point struct when needed. TODO: test and toggle function call in main.rs

…in.rs

…point struct when needed. TODO: test and toggle function call in main.rs

… in main.rs and test into_analyzble_function use case in main.rs

…ent {function: str} entry points. Added missing entrypoints on jira:customField and implmented scanning for those

…d with optional values

…on, and resolver for less code duplication. Updated into_analayzable method to update values based on functions specified in function mod. TODO: Update rest of non trigger modules to update mapping to functions to scan from function mod

…in.rs

…rked

…1893

awang7 added 7 commits September 11, 2023 15:01

added new structs for user non-invokable modules

75985e9

added more todo statements and cleaned up struct definitions

a585f2e

fixed all the red squigglies

a169dc3

added user-invokable module with additional entry points for macros. …

b4455a1

…Adding more modules. Writing tests next?

added test to deserialize macros with additional entry points like co…

d38aa7a

…nfig and export

edited main to iterate over vector of functions. TODO: edit add_funcs…

cd2ed7b

… in main.rs and test into_analyzble_function use case in main.rs

awang7 added 3 commits September 18, 2023 11:09

added new modules for additional endpoints in user invokable modules

31a3048

added methods for adding additional user invokable endpoints to vecto…

559dc5b

…r for scanning.

removed callback mod and abstracted structs to use MacroMod to repres…

826accc

…ent {function: str} entry points. Added missing entrypoints on jira:customField and implmented scanning for those

jwong101 reviewed Sep 18, 2023

View reviewed changes

awang7 added 12 commits September 18, 2023 18:21

changed entrypoints to entrypoint. Working on other comments

b955fa7

updated struct serde features and rust attributes. Updated customFiel…

58fe585

…d with optional values

finished updating methods to check functions_to_scan and update entry…

24d99b2

…point struct when needed. TODO: test and toggle function call in main.rs

commented out consumer filter

7f2098c

updated search_suggestion in customfield to be an optional value.

3b3fb38

modified into_analyzable_functions with Josh and implementation in ma…

29c38d6

…in.rs

feat: building path to capture a require import

8138dc5

feat: built checking for require function. Todo: build part that scan…

f989613

…s for imports using require

feat: added implementation to check if package is part of packages we…

cf7d3e4

… are scanning for

chore: cleaned up debug comments

2a1cf39

chore: secret_package variable so it can be tracked in debug messages

13e1c80

jwong101 marked this pull request as ready for review January 3, 2024 17:10

awang7 added 5 commits January 8, 2024 12:06

resolving merge conflicts for rebase

506ee57

added more todo statements and cleaned up struct definitions

fb13240

resolving merge conflicts for rebase

dc0dfa2

resolving merge conflicts

a9894c3

resolving merge conflicts

4d4f789

aliner-wang added 29 commits February 9, 2024 15:31

finished updating methods to check functions_to_scan and update entry…

f40fa88

…point struct when needed. TODO: test and toggle function call in main.rs

commented out consumer filter

0f0649f

updated search_suggestion in customfield to be an optional value.

b0d32c6

modified into_analyzable_functions with Josh and implementation in ma…

9814698

…in.rs

rebased EAS-1893

8ec6866

chore: updated main.rs file to remove vscode notes

db608ea

resolving merge conflicts for rebase

42a2831

added more todo statements and cleaned up struct definitions

a95d2f0

resolving merge conflicts for rebase

05e1572

resolving merge conflicts

c85ca77

resolving merge conflicts

cab1b8d

resolving merge conflicts

07bea42

changed entrypoints to entrypoint. Working on other comments

b229ad1

resolving merge conflicts

0475adb

resolving merge conflicts

9fb82e8

finished updating methods to check functions_to_scan and update entry…

7572b16

…point struct when needed. TODO: test and toggle function call in main.rs

manually resolved some thigns

de569cb

added new structs for user non-invokable modules

9bb3a76

added more todo statements and cleaned up struct definitions

4738a80

edited main to iterate over vector of functions. TODO: edit add_funcs…

dad24aa

… in main.rs and test into_analyzble_function use case in main.rs

resolving more confliicts T.T'

c7d2a3e

resolving more confliicts T.T'

aa6893d

removed callback mod and abstracted structs to use MacroMod to repres…

fe30d12

…ent {function: str} entry points. Added missing entrypoints on jira:customField and implmented scanning for those

updated struct serde features and rust attributes. Updated customFiel…

0eba620

…d with optional values

modified into_analyzable_functions with Josh and implementation in ma…

f9a282c

…in.rs

rebased EAS-1893 - changing author attempt

57c64cd

chore: tried rebasing to change all author's on commits. Partially wo…

116bf18

…rked

Merge remote-tracking branch 'refs/remotes/origin/EAS-1893' into EAS-…

b6a2aef

…1893

jwong101 closed this Feb 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Eas 1893 #27

Eas 1893 #27

aliner-wang commented Sep 18, 2023

atlassian-cla-bot bot commented Sep 18, 2023 •

edited

Loading

jwong101 Sep 18, 2023

jwong101 Sep 18, 2023

jwong101 Sep 18, 2023

aliner-wang Sep 18, 2023

aliner-wang Sep 18, 2023

aliner-wang Sep 18, 2023 •

edited

Loading

jwong101 Sep 19, 2023

jwong101 Sep 18, 2023

aliner-wang Sep 18, 2023

jwong101 Sep 19, 2023

jwong101 Sep 18, 2023

jwong101 Sep 18, 2023

jwong101 Sep 18, 2023

jwong101 Sep 18, 2023

jwong101 Sep 18, 2023

aliner-wang Sep 19, 2023

jwong101 Sep 19, 2023

	resolver: ModInfo<'a>
	#[serde(flatten, borrow)]
	resolver: Option<ModInfo<'a>>

	function: &'a str,
	#[serde(borrow)]
	function: Option<&'a str>,

Eas 1893 #27

Eas 1893 #27

Conversation

aliner-wang commented Sep 18, 2023

atlassian-cla-bot bot commented Sep 18, 2023 • 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

aliner-wang Sep 18, 2023 • 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

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

atlassian-cla-bot bot commented Sep 18, 2023 •

edited

Loading

aliner-wang Sep 18, 2023 •

edited

Loading