Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update website to display new workload and suite changes correctly #10

Merged
merged 4 commits into from
Jan 25, 2024

Conversation

Harshil2107
Copy link
Contributor

@Harshil2107 Harshil2107 commented Jan 4, 2024

This change has 3 parts:

  • Updating the gem5 resources schema to now include suites and new changes to the workloads JSON object.
  • Fixing a bug that was introduced due to the change made to workloads where new workloads with the new JSON format were not displayed on the website.
  • Updating the tests that would fail due to addition on the new category "suite".

@powerjg
Copy link

powerjg commented Jan 9, 2024

Can you give some context to this change with the commit message or the PR message? I don't know what I'm reviewing.

Copy link

@powerjg powerjg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like there's a lot more than just "fix workload bug" in this PR. Please update the PR description and/or commits to make it more clear how to review this.

package.json Show resolved Hide resolved
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change seems unrelated to "workload bug"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is related in the sense that this change contains new schema, we were waiting on updating website till the release. So I added the bug fix as the bug was introduced due to the updated schema for workloads. So I added the bug fix on top of the schema change.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think a better title to the PR would be "adapt website to new schema" and one of the commits could be "fix bug <give more information."

Remember, the people reviewing the code can't read your mind, and they likely will forget all of the information that you've told them previously. Each PR should be completely stand alone and someone should be able to understand why you made each change in the PR with the information in the PR.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are there 2-3 copies of this file?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are 2 copies of the latest schema on in the test folder and one in public. The reason for having two separate copies is to catch the change in schema and so we have to update the tests accordingly.

There is also a new folder which will keep older schemas in case we need to refer to them.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you have a symlink from the tests to the public one?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I think we can. Our thought process when adding separate files was that if there is a major schema change like in our case adding a new category then the cypress test will fail. This was to make sure that such schema changes are caught and then tests have to be modified, this also serves as a way to double check that schema does not break anything else.

package-lock.json Show resolved Hide resolved
@Harshil2107
Copy link
Contributor Author

Can you give some context to this change with the commit message or the PR message? I don't know what I'm reviewing.

I updated the PR message.

Copy link
Member

@BobbyRBruce BobbyRBruce left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Fix workload bug" doesn't really mean much to me here. Can we have something a bit more descriptive?

I'm honestly a bit lost as to what our schema means anymore. We're changing it here and I don't know why and what it means for gem5-resources. Can we just update this whenever we want or are there procedures we need to follow?

package-lock.json Show resolved Hide resolved
@Harshil2107
Copy link
Contributor Author

I think we help off on the schema update till release. I dont know if we have a strong reason part for wanting at most one schema change per release?

In this update the change to schema are the following:

  • Added suites as a category.
  • Updated the workload schema so that now the resources field is
resources: {
  binary: { 
                  'id': id,
                  'resource_version':"1.0.0"
                  },
  .
  .
  .
  } 

The older resources filed was:

resources: {
  binary: id,
  .
  .
  .
  }

@Harshil2107 Harshil2107 changed the title Fix workload bug Update website to display new workload and suite changes correctly Jan 9, 2024
Copy link
Member

@BobbyRBruce BobbyRBruce left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still have a hard time wrapping my head around what the purpose is anymore for the schema. I feel we have deviated from our original goal and i worry we're just updating it as we need it in a hacky way.

However, if this fixes the bug then we should get it in and we can discuss procedure later.

@BobbyRBruce BobbyRBruce merged commit 37f5589 into gem5:main Jan 25, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants