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

HPCC-32594 ECL Watch v9 prevent duplicate errors logged on File Details #19094

Closed
wants to merge 1 commit into from

Conversation

jeclrsg
Copy link
Contributor

@jeclrsg jeclrsg commented Sep 6, 2024

fixes an issue where the Files Details page would potentially log multiple duplicate errors due to the interdependence of the various file hooks (which all consume useFile).

also, sets default values for name and image in the LogicalFileSummary component for the scenario of viewing a deleted file.

Type of change:

  • This change is a bug fix (non-breaking change which fixes an issue).
  • This change is a new feature (non-breaking change which adds functionality).
  • This change improves the code (refactor or other change that does not change the functionality)
  • This change fixes warnings (the fix does not alter the functionality or the generated code)
  • This change is a breaking change (fix or feature that will cause existing behavior to change).
  • This change alters the query API (existing queries will have to be recompiled)

Checklist:

  • My code follows the code style of this project.
    • My code does not create any new warnings from compiler, build system, or lint.
  • The commit message is properly formatted and free of typos.
    • The commit message title makes sense in a changelog, by itself.
    • The commit is signed.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly, or...
    • I have created a JIRA ticket to update the documentation.
    • Any new interfaces or exported functions are appropriately commented.
  • I have read the CONTRIBUTORS document.
  • The change has been fully tested:
    • I have added tests to cover my changes.
    • All new and existing tests passed.
    • I have checked that this change does not introduce memory leaks.
    • I have used Valgrind or similar tools to check for potential issues.
  • I have given due consideration to all of the following potential concerns:
    • Scalability
    • Performance
    • Security
    • Thread-safety
    • Cloud-compatibility
    • Premature optimization
    • Existing deployed queries will not be broken
    • This change fixes the problem, not just the symptom
    • The target branch of this pull request is appropriate for such a change.
  • There are no similar instances of the same problem that should be addressed
    • I have addressed them here
    • I have raised JIRA issues to address them separately
  • This is a user interface / front-end modification
    • I have tested my changes in multiple modern browsers
    • The component(s) render as expected

Smoketest:

  • Send notifications about my Pull Request position in Smoketest queue.
  • Test my draft Pull Request.

Testing:

fixes an issue where the Files Details page would potentially log
multiple duplicate errors due to the interdependence of the various
file hooks (which all consume useFile).

also, sets default values for name and image in the LogicalFileSummary
component for the scenario of viewing a deleted file.

Signed-off-by: Jeremy Clements <[email protected]>
@jeclrsg jeclrsg requested a review from GordonSmith September 6, 2024 20:50
Copy link

github-actions bot commented Sep 6, 2024

Jira Issue: https://hpccsystems.atlassian.net//browse/HPCC-32594

Jirabot Action Result:
Workflow Transition To: Merge Pending
Updated PR

return <_.FileDetails cluster={undefined} logicalFile={params.Name as string} />;
})
path: "/:Name", action: (ctx, params) => {
const FileContextProvider = React.lazy(() => import("./components/contexts/FileContext"));
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 a bit different, but I wasn't quite sure what would be better for conditionally loading more than one component in these router callbacks. I found this React.lazy in the docs, and it required wrapping in this React.Suspense to render properly. lazy() also expects the component being loaded to have a default export, hence the one line change to FileDetails.

Copy link
Member

Choose a reason for hiding this comment

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

My understanding is that the only diff between a raw dynamic import and the React.lazy, is the facility to supply a "loading" message?
From our point of view, ensuring that these are bundled into individual "chunks" and loaded "on demand" is v. important as it facilitates the gradual migration away from Dojo (by better encapsulation)

return context;
};

export default FileContextProvider;
Copy link
Member

Choose a reason for hiding this comment

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

Picky: For consistency, there is no need to have a default export...

@@ -156,3 +156,5 @@ export const FileDetails: React.FunctionComponent<FileDetailsProps> = ({
</div>
}</SizeMe>;
};

export default FileDetails;
Copy link
Member

Choose a reason for hiding this comment

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

Picky: For consistency, there is no need to have a default export...

return <_.FileDetails cluster={undefined} logicalFile={params.Name as string} />;
})
path: "/:Name", action: (ctx, params) => {
const FileContextProvider = React.lazy(() => import("./components/contexts/FileContext"));
Copy link
Member

Choose a reason for hiding this comment

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

My understanding is that the only diff between a raw dynamic import and the React.lazy, is the facility to supply a "loading" message?
From our point of view, ensuring that these are bundled into individual "chunks" and loaded "on demand" is v. important as it facilitates the gradual migration away from Dojo (by better encapsulation)

<FileDetails cluster={undefined} logicalFile={params.Name as string} />
</FileContextProvider>
</React.Suspense>;
}
Copy link
Member

Choose a reason for hiding this comment

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

This looks like an "anti-pattern"? Why is FileDetails visible here?

<FileDetails cluster={params.NodeGroup as string} logicalFile={params.Name as string} />
</FileContextProvider>
</React.Suspense>;
}
Copy link
Member

Choose a reason for hiding this comment

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

Ditto

<FileDetails cluster={params.NodeGroup as string} logicalFile={params.Name as string} tab={params.Tab as string} sort={{ [params.Tab as string]: parseSort(ctx.search) }} queryParams={{ [params.Tab as string]: parseSearch(ctx.search) as any }} />
</FileContextProvider>
</React.Suspense>;
}
Copy link
Member

Choose a reason for hiding this comment

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

Ditto

@jeclrsg jeclrsg closed this Sep 11, 2024
@jeclrsg jeclrsg deleted the hpcc-32594-v9-viewing-deleted-file branch September 12, 2024 21:44
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.

2 participants